e84be052430a896877a4740d629362b980ccd4f2
[core.git] / inc / main / classes / factories / cache / class_CacheFactory.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Factory\Cache;
4
5 /**
6  * A cache factory
7  *
8  * @author              Roland Haeder <webmaster@shipsimu.org>
9  * @version             0.0.0
10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
11  * @license             GNU GPL 3.0 or any newer version
12  * @link                http://www.shipsimu.org
13  *
14  * This program is free software: you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation, either version 3 of the License, or
17  * (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
26  */
27 class CacheFactory extends BaseFactory {
28         /**
29          * Singleton instance
30          */
31         private static $selfInstance = NULL;
32
33         /**
34          * Protected constructor
35          *
36          * @return      void
37          */
38         protected function __construct () {
39                 // Call parent constructor
40                 parent::__construct(__CLASS__);
41         }
42
43         /**
44          * Singleton getter for this class
45          *
46          * @return      $selfInstance   An instance of this class
47          */
48         public static final function getFactory () {
49                 // Is the instance null?
50                 if (is_null(self::$selfInstance)) {
51                         // Set a new one
52                         self::$selfInstance = new CacheFactory();
53                 } // END - if
54
55                 // Return the instance
56                 return self::$selfInstance;
57         }
58
59         /**
60          * Creates a configured cache instance
61          *
62          * @return      $cacheInstance  An instance of the configured cache
63          */
64         public function createConfiguredCache () {
65                 // Read the config entry
66                 $cacheType = $this->getConfigInstance()->getConfigEntry('cache_class');
67
68                 // And get a new instance
69                 $cacheInstance = ObjectFactory::createObjectByName($cacheType);
70
71                 // Return the instance
72                 return $cacheInstance;
73         }
74
75 }