Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
100.00% |
1 / 1 |
|
100.00% |
5 / 5 |
CRAP | |
100.00% |
16 / 16 |
FileCacheFactory | |
100.00% |
1 / 1 |
|
100.00% |
5 / 5 |
7 | |
100.00% |
16 / 16 |
get | |
100.00% |
1 / 1 |
3 | |
100.00% |
10 / 10 |
|||
getConfiguration | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
setConfiguration | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
getPrefix | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
setPrefix | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\Component\FileCache\FileCacheFactory. | |
*/ | |
namespace Drupal\Component\FileCache; | |
/** | |
* Creates a FileCache object. | |
*/ | |
class FileCacheFactory { | |
/** | |
* The configuration used to create FileCache objects. | |
* | |
* @var array $configuration | |
*/ | |
protected static $configuration; | |
/** | |
* The cache prefix. | |
* | |
* @var string | |
*/ | |
protected static $prefix; | |
/** | |
* Instantiates a FileCache object for a given collection identifier. | |
* | |
* @param string $collection | |
* The collection identifier for this FileCache. | |
* @param array $default_configuration | |
* (optional) The default configuration for this FileCache collection. This | |
* can be used to e.g. specify default usage of a FileCache class. | |
* | |
* @return \Drupal\Component\FileCache\FileCacheInterface | |
* The initialized FileCache object. | |
*/ | |
public static function get($collection, $default_configuration = []) { | |
$default_configuration += [ | |
'class' => '\Drupal\Component\FileCache\FileCache', | |
'collection' => $collection, | |
'cache_backend_class' => NULL, | |
'cache_backend_configuration' => [], | |
]; | |
$configuration = []; | |
if (isset(static::$configuration[$collection])) { | |
$configuration = static::$configuration[$collection]; | |
} | |
elseif (isset(static::$configuration['default'])) { | |
$configuration = static::$configuration['default']; | |
} | |
// Add defaults to the configuration. | |
$configuration = $configuration + $default_configuration; | |
$class = $configuration['class']; | |
return new $class(static::getPrefix(), $configuration['collection'], $configuration['cache_backend_class'], $configuration['cache_backend_configuration']); | |
} | |
/** | |
* Gets the configuration used for constructing future file cache objects. | |
* | |
* @return array | |
* The configuration that is used. | |
*/ | |
public static function getConfiguration() { | |
return static::$configuration; | |
} | |
/** | |
* Sets the configuration to use for constructing future file cache objects. | |
* | |
* @param array $configuration | |
* The configuration to use. | |
*/ | |
public static function setConfiguration($configuration) { | |
static::$configuration = $configuration; | |
} | |
/** | |
* Returns the cache prefix. | |
* | |
* @return string | |
* The cache prefix. | |
*/ | |
public static function getPrefix() { | |
return static::$prefix; | |
} | |
/** | |
* Sets the cache prefix that should be used. | |
* | |
* Should be set to a secure, unique key to prevent cache pollution by a | |
* third party. | |
* | |
* @param string $prefix | |
* The cache prefix. | |
*/ | |
public static function setPrefix($prefix) { | |
static::$prefix = $prefix; | |
} | |
} |