Elgg  Version master
Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Static Protected Attributes | List of all members
Phpfastcache\CacheManager Class Reference

Static Public Member Functions

static getInstanceById (string $instanceId)
 
static getInstances ()
 Return the list of instances. More...
 
static & getInternalInstances ()
 This method is intended for internal use only and should not be used for any external development use the getInstances() method instead. More...
 
static __callStatic (string $name, array $arguments)
 
static getInstance (string $driver,?ConfigurationOptionInterface $config=null,?string $instanceId=null)
 
static getDefaultConfig ()
 
static standardizeDriverName (string $driverName)
 
static getDriverClass (string $driverName)
 
static getNamespacePath ()
 
static getDefaultNamespacePath ()
 
static clearInstances ()
 
static clearInstance (ExtendedCacheItemPoolInterface $cachePoolInstance)
 
static setDefaultConfig (ConfigurationOption $config)
 
static addCustomDriver (string $driverName, string $className)
 
static getDriverList (bool $FQCNAsKey=false)
 Return the list of available drivers Capitalized with optional FQCN as key. More...
 
static removeCustomDriver (string $driverName)
 
static addCoreDriverOverride (string $driverName, string $className)
 
static removeCoreDriverOverride (string $driverName)
 

Public Attributes

const CORE_DRIVER_NAMESPACE = 'Phpfastcache\Drivers\\'
 

Protected Member Functions

 __construct ()
 CacheManager constructor. More...
 

Static Protected Member Functions

static validateConfig (?ConfigurationOptionInterface $config)
 
static validateDriverClass (string $driverClass)
 

Static Protected Attributes

static $config
 
static $namespacePath
 
static $instances = []
 
static $driverOverrides = []
 
static $driverCustoms = []
 

Detailed Description

Definition at line 62 of file CacheManager.php.

Constructor & Destructor Documentation

Phpfastcache\CacheManager::__construct ( )
finalprotected

CacheManager constructor.

Definition at line 95 of file CacheManager.php.

Member Function Documentation

static Phpfastcache\CacheManager::__callStatic ( string  $name,
array  $arguments 
)
static
Parameters
string$name
array$arguments
Returns
ExtendedCacheItemPoolInterface
Exceptions
PhpfastcacheDriverCheckException
PhpfastcacheDriverException
PhpfastcacheDriverNotFoundException
PhpfastcacheInvalidArgumentException
PhpfastcacheInvalidConfigurationException
PhpfastcacheLogicException

Definition at line 151 of file CacheManager.php.

static Phpfastcache\CacheManager::addCoreDriverOverride ( string  $driverName,
string  $className 
)
static
Parameters
string$driverName
string$className
Returns
void
Exceptions
PhpfastcacheLogicException
PhpfastcacheUnsupportedOperationException
PhpfastcacheInvalidArgumentException

Definition at line 436 of file CacheManager.php.

static Phpfastcache\CacheManager::addCustomDriver ( string  $driverName,
string  $className 
)
static
Parameters
string$driverName
string$className
Returns
void
Exceptions
PhpfastcacheLogicException
PhpfastcacheUnsupportedOperationException
PhpfastcacheInvalidArgumentException

Definition at line 339 of file CacheManager.php.

static Phpfastcache\CacheManager::clearInstance ( ExtendedCacheItemPoolInterface  $cachePoolInstance)
static
Parameters
ExtendedCacheItemPoolInterface$cachePoolInstance
Returns
bool
Since
7.0.4

Definition at line 304 of file CacheManager.php.

static Phpfastcache\CacheManager::clearInstances ( )
static
Returns
bool

Definition at line 291 of file CacheManager.php.

static Phpfastcache\CacheManager::getDefaultConfig ( )
static
Returns
ConfigurationOptionInterface
Exceptions
PhpfastcacheInvalidConfigurationException

Definition at line 220 of file CacheManager.php.

static Phpfastcache\CacheManager::getDefaultNamespacePath ( )
static
Returns
string

Definition at line 283 of file CacheManager.php.

static Phpfastcache\CacheManager::getDriverClass ( string  $driverName)
static
Parameters
string$driverName
Returns
string

Definition at line 257 of file CacheManager.php.

static Phpfastcache\CacheManager::getDriverList ( bool  $FQCNAsKey = false)
static

Return the list of available drivers Capitalized with optional FQCN as key.

Parameters
bool$FQCNAsKeyDescribe keys with Full Qualified Class Name
Returns
string[]
Exceptions
PhpfastcacheUnsupportedOperationException

Definition at line 372 of file CacheManager.php.

static Phpfastcache\CacheManager::getInstance ( string  $driver,
?ConfigurationOptionInterface  $config = null,
?string  $instanceId = null 
)
static
Parameters
string$driver
ConfigurationOptionInterface$config
string | null$instanceId
Returns
ExtendedCacheItemPoolInterface|AggregatablePoolInterface
Exceptions
PhpfastcacheDriverCheckException
PhpfastcacheDriverException
PhpfastcacheDriverNotFoundException
PhpfastcacheInvalidArgumentException
PhpfastcacheInvalidConfigurationException
PhpfastcacheLogicException

Definition at line 171 of file CacheManager.php.

static Phpfastcache\CacheManager::getInstanceById ( string  $instanceId)
static
Parameters
string$instanceId
Returns
ExtendedCacheItemPoolInterface
Exceptions
PhpfastcacheInstanceNotFoundException

Definition at line 105 of file CacheManager.php.

static Phpfastcache\CacheManager::getInstances ( )
static

Return the list of instances.

Returns
ExtendedCacheItemPoolInterface[]

Definition at line 119 of file CacheManager.php.

static& Phpfastcache\CacheManager::getInternalInstances ( )
static

This method is intended for internal use only and should not be used for any external development use the getInstances() method instead.

Returns
ExtendedCacheItemPoolInterface[]

Definition at line 134 of file CacheManager.php.

static Phpfastcache\CacheManager::getNamespacePath ( )
static
Returns
string

Definition at line 275 of file CacheManager.php.

static Phpfastcache\CacheManager::removeCoreDriverOverride ( string  $driverName)
static
Parameters
string$driverName
Returns
void
Exceptions
PhpfastcacheLogicException
PhpfastcacheInvalidArgumentException

Definition at line 478 of file CacheManager.php.

static Phpfastcache\CacheManager::removeCustomDriver ( string  $driverName)
static
Parameters
string$driverName
Returns
void
Exceptions
PhpfastcacheLogicException
PhpfastcacheInvalidArgumentException

Definition at line 413 of file CacheManager.php.

static Phpfastcache\CacheManager::setDefaultConfig ( ConfigurationOption  $config)
static
Parameters
ConfigurationOption$config

Definition at line 326 of file CacheManager.php.

static Phpfastcache\CacheManager::standardizeDriverName ( string  $driverName)
static
Parameters
string$driverName
Returns
string

Definition at line 229 of file CacheManager.php.

static Phpfastcache\CacheManager::validateConfig ( ?ConfigurationOptionInterface  $config)
staticprotected
Parameters
ConfigurationOptionInterface | null$config
Returns
ConfigurationOption
Exceptions
PhpfastcacheInvalidArgumentException
PhpfastcacheInvalidConfigurationException

Definition at line 202 of file CacheManager.php.

static Phpfastcache\CacheManager::validateDriverClass ( string  $driverClass)
staticprotected
Parameters
string$driverClass
Returns
string|ExtendedCacheItemPoolInterface
Exceptions
PhpfastcacheDriverException

Definition at line 239 of file CacheManager.php.

Member Data Documentation

Phpfastcache\CacheManager::$config
staticprotected

Definition at line 71 of file CacheManager.php.

Phpfastcache\CacheManager::$driverCustoms = []
staticprotected

Definition at line 90 of file CacheManager.php.

Phpfastcache\CacheManager::$driverOverrides = []
staticprotected

Definition at line 85 of file CacheManager.php.

Phpfastcache\CacheManager::$instances = []
staticprotected

Definition at line 80 of file CacheManager.php.

Phpfastcache\CacheManager::$namespacePath
staticprotected

Definition at line 75 of file CacheManager.php.

const Phpfastcache\CacheManager::CORE_DRIVER_NAMESPACE = 'Phpfastcache\Drivers\\'

Definition at line 64 of file CacheManager.php.


The documentation for this class was generated from the following file: