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