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