Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\FileCache;
Chris@0: 
Chris@0: /**
Chris@0:  * Creates a FileCache object.
Chris@0:  */
Chris@0: class FileCacheFactory {
Chris@0: 
Chris@0:   /**
Chris@0:    * The configuration key to disable FileCache completely.
Chris@0:    */
Chris@0:   const DISABLE_CACHE = 'file_cache_disable';
Chris@0: 
Chris@0:   /**
Chris@0:    * The configuration used to create FileCache objects.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected static $configuration;
Chris@0: 
Chris@0:   /**
Chris@0:    * The cache prefix.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected static $prefix;
Chris@0: 
Chris@0:   /**
Chris@0:    * Instantiates a FileCache object for a given collection identifier.
Chris@0:    *
Chris@0:    * @param string $collection
Chris@0:    *   The collection identifier for this FileCache.
Chris@0:    * @param array $default_configuration
Chris@0:    *   (optional) The default configuration for this FileCache collection. This
Chris@0:    *   can be used to e.g. specify default usage of a FileCache class.
Chris@0:    *
Chris@0:    * @return \Drupal\Component\FileCache\FileCacheInterface
Chris@0:    *   The initialized FileCache object.
Chris@0:    */
Chris@0:   public static function get($collection, $default_configuration = []) {
Chris@0:     // If there is a special key in the configuration, disable FileCache completely.
Chris@0:     if (!empty(static::$configuration[static::DISABLE_CACHE])) {
Chris@0:       return new NullFileCache('', '');
Chris@0:     }
Chris@0: 
Chris@0:     $configuration = [];
Chris@0: 
Chris@0:     // Check for a collection specific setting first.
Chris@0:     if (isset(static::$configuration[$collection])) {
Chris@0:       $configuration += static::$configuration[$collection];
Chris@0:     }
Chris@0:     // Then check if a default configuration has been provided.
Chris@0:     if (!empty($default_configuration)) {
Chris@0:       $configuration += $default_configuration;
Chris@0:     }
Chris@0:     // Last check if a default setting has been provided.
Chris@0:     if (isset(static::$configuration['default'])) {
Chris@0:       $configuration += static::$configuration['default'];
Chris@0:     }
Chris@0: 
Chris@0:     // Ensure that all properties are set.
Chris@0:     $fallback_configuration = [
Chris@0:       'class' => '\Drupal\Component\FileCache\FileCache',
Chris@0:       'collection' => $collection,
Chris@0:       'cache_backend_class' => NULL,
Chris@0:       'cache_backend_configuration' => [],
Chris@0:     ];
Chris@0: 
Chris@0:     $configuration = $configuration + $fallback_configuration;
Chris@0: 
Chris@0:     $class = $configuration['class'];
Chris@0:     return new $class(static::getPrefix(), $configuration['collection'], $configuration['cache_backend_class'], $configuration['cache_backend_configuration']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Gets the configuration used for constructing future file cache objects.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The configuration that is used.
Chris@0:    */
Chris@0:   public static function getConfiguration() {
Chris@0:     return static::$configuration;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the configuration to use for constructing future file cache objects.
Chris@0:    *
Chris@0:    * @param array $configuration
Chris@0:    *   The configuration to use.
Chris@0:    */
Chris@0:   public static function setConfiguration($configuration) {
Chris@0:     static::$configuration = $configuration;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the cache prefix.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   The cache prefix.
Chris@0:    */
Chris@0:   public static function getPrefix() {
Chris@0:     return static::$prefix;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Sets the cache prefix that should be used.
Chris@0:    *
Chris@0:    * Should be set to a secure, unique key to prevent cache pollution by a
Chris@0:    * third party.
Chris@0:    *
Chris@0:    * @param string $prefix
Chris@0:    *   The cache prefix.
Chris@0:    */
Chris@0:   public static function setPrefix($prefix) {
Chris@0:     static::$prefix = $prefix;
Chris@0:   }
Chris@0: 
Chris@0: }