class FileCacheFactory
Same name in other branches
- 9 core/lib/Drupal/Component/FileCache/FileCacheFactory.php \Drupal\Component\FileCache\FileCacheFactory
- 8.9.x core/lib/Drupal/Component/FileCache/FileCacheFactory.php \Drupal\Component\FileCache\FileCacheFactory
- 11.x core/lib/Drupal/Component/FileCache/FileCacheFactory.php \Drupal\Component\FileCache\FileCacheFactory
Creates a FileCache object.
Hierarchy
- class \Drupal\Component\FileCache\FileCacheFactory
Expanded class hierarchy of FileCacheFactory
27 files declare their use of FileCacheFactory
- AnnotatedClassDiscovery.php in core/
lib/ Drupal/ Component/ Annotation/ Plugin/ Discovery/ AnnotatedClassDiscovery.php - AnnotatedClassDiscoveryCachedTest.php in core/
tests/ Drupal/ Tests/ Component/ Annotation/ AnnotatedClassDiscoveryCachedTest.php - AnnotatedClassDiscoveryTest.php in core/
tests/ Drupal/ Tests/ Component/ Annotation/ AnnotatedClassDiscoveryTest.php - AnnotatedClassDiscoveryTest.php in core/
tests/ Drupal/ Tests/ Component/ Plugin/ Discovery/ AnnotatedClassDiscoveryTest.php - AttributeClassDiscovery.php in core/
lib/ Drupal/ Component/ Plugin/ Discovery/ AttributeClassDiscovery.php
File
-
core/
lib/ Drupal/ Component/ FileCache/ FileCacheFactory.php, line 8
Namespace
Drupal\Component\FileCacheView source
class FileCacheFactory {
/**
* The configuration key to disable FileCache completely.
*/
const DISABLE_CACHE = 'file_cache_disable';
/**
* The configuration used to create FileCache objects.
*
* @var array
*/
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 = []) {
// If there is a special key in the configuration, disable FileCache completely.
if (!empty(static::$configuration[static::DISABLE_CACHE])) {
return new NullFileCache('', '');
}
$configuration = [];
// Check for a collection specific setting first.
if (isset(static::$configuration[$collection])) {
$configuration += static::$configuration[$collection];
}
// Then check if a default configuration has been provided.
if (!empty($default_configuration)) {
$configuration += $default_configuration;
}
// Last check if a default setting has been provided.
if (isset(static::$configuration['default'])) {
$configuration += static::$configuration['default'];
}
// Ensure that all properties are set.
$fallback_configuration = [
'class' => '\\Drupal\\Component\\FileCache\\FileCache',
'collection' => $collection,
'cache_backend_class' => NULL,
'cache_backend_configuration' => [],
];
$configuration = $configuration + $fallback_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;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
FileCacheFactory::$configuration | protected static | property | The configuration used to create FileCache objects. |
FileCacheFactory::$prefix | protected static | property | The cache prefix. |
FileCacheFactory::DISABLE_CACHE | constant | The configuration key to disable FileCache completely. | |
FileCacheFactory::get | public static | function | Instantiates a FileCache object for a given collection identifier. |
FileCacheFactory::getConfiguration | public static | function | Gets the configuration used for constructing future file cache objects. |
FileCacheFactory::getPrefix | public static | function | Returns the cache prefix. |
FileCacheFactory::setConfiguration | public static | function | Sets the configuration to use for constructing future file cache objects. |
FileCacheFactory::setPrefix | public static | function | Sets the cache prefix that should be used. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.