Code merge from latest Ship-Simu code
[mailer.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, 2008 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                 // Set object description
40                 $this->setObjectDescription("Factory for cache objects");
41
42                 // Create unique ID number
43                 $this->createUniqueID();
44         }
45
46         /**
47          * Singleton getter for this class
48          *
49          * @return      $selfInstance   An instance of this class
50          */
51         public final static function getFactory () {
52                 // Is the instance null?
53                 if (is_null(self::$selfInstance)) {
54                         // Set a new one
55                         self::$selfInstance = new CacheFactory();
56                 }
57
58                 // Return the instance
59                 return self::$selfInstance;
60         }
61
62         /**
63          * Creates a configured cache instance
64          *
65          * @return      $cacheInstance  An instance of the configured cache
66          */
67         public function createConfiguredCache () {
68                 // Read the config entry
69                 $cacheType = $this->getConfigInstance()->readConfig("cache_type");
70
71                 // And get a new instance
72                 $cacheInstance = ObjectFactory::createObjectByName($cacheType);
73
74                 // Return the instance
75                 return $cacheInstance;
76         }
77 }
78
79 // [EOF]
80 ?>