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