framework/main/classes/factories/cache/class_CacheFactory.php

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