Class XcacheEngine
Xcache storage engine for cache
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayThe default config used unless overridden by runtime configuration
-
$_groupPrefix protected
stringContains the compiled string with all groups prefixes to be prepended to every key in this cache engine
Method Summary
-
_auth() protected
Populates and reverses $_SERVER authentication values Makes necessary changes (and reverting them back) in $_SERVER
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_key() protected
Generates a safe key, taking account of the configured key prefix
-
add() public
Add a key to the cache if it does not already exist.
-
clear() public
Delete all keys from the cache
-
clearGroup() public
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
-
config() public deprecated
Gets/Sets the config.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
decrement() public
Decrements the value of an integer cached key. If the cache key is not an integer it will be treated as 0
-
delete() public
Delete a key from the cache
-
deleteMany() public
Deletes keys from the cache
-
gc() public
Garbage collection
-
getConfig() public
Returns the config.
-
groups() public
Returns the
group valuefor each of the configured groups If the group initial value was not found, then it initializes the group accordingly. -
increment() public
Increments the value of an integer cached key If the cache key is not an integer it will be treated as 0
-
init() public
Initialize the Cache Engine
-
key() public
Generates a safe key for use with cache engine storage engines.
-
read() public
Read a key from the cache
-
readMany() public
Read multiple keys from the cache
-
setConfig() public
Sets the config.
-
write() public
Write data for key into cache
-
writeMany() public
Write data for many keys into cache
Method Detail
_auth() ¶ protected
_auth(bool $reverse = false): voidPopulates and reverses $_SERVER authentication values Makes necessary changes (and reverting them back) in $_SERVER
This has to be done because xcache_clear_cache() needs to pass Basic Http Auth (see xcache.admin configuration config)
Parameters
-
bool$reverse optional Revert changes
Returns
void_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites a config key.
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_key() ¶ protected
_key(string $key): mixedGenerates a safe key, taking account of the configured key prefix
Parameters
-
string$key the key passed over
Returns
mixedThrows
InvalidArgumentExceptionIf key's value is empty
add() ¶ public
add(string $key, mixed $value): boolAdd a key to the cache if it does not already exist.
Defaults to a non-atomic implementation. Subclasses should prefer atomic implementations.
Parameters
-
string$key Identifier for the data.
-
mixed$value Data to be cached.
Returns
boolclear() ¶ public
clear(bool $check): boolDelete all keys from the cache
Parameters
-
bool$check If true no deletes will occur and instead CakePHP will rely on key TTL values. Unused for Xcache engine.
Returns
boolclearGroup() ¶ public
clearGroup(string $group): boolIncrements the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Parameters
-
string$group The group to clear.
Returns
boolconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/Sets the config.
Usage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);Setting a nested value:
$this->configShallow('some.nested.key', $value);Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisdecrement() ¶ public
decrement(string $key, int $offset = 1): bool|intDecrements the value of an integer cached key. If the cache key is not an integer it will be treated as 0
Parameters
-
string$key Identifier for the data
-
int$offset optional How much to subtract
Returns
bool|intdelete() ¶ public
delete(string $key): boolDelete a key from the cache
Parameters
-
string$key Identifier for the data
Returns
booldeleteMany() ¶ public
deleteMany(array $keys): arrayDeletes keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arraygc() ¶ public
gc(int|null $expires = null): voidGarbage collection
Permanently remove all expired and deleted data
Parameters
-
int|null$expires optional [optional] An expires timestamp, invalidating all data before.
Returns
voidgetConfig() ¶ public
getConfig(string|null $key = null): mixedReturns the config.
Usage
Reading the whole config:
$this->getConfig();Reading a specific value:
$this->getConfig('key');Reading a nested value:
$this->getConfig('some.nested.key');Parameters
-
string|null$key optional The key to get or null for the whole config.
Returns
mixedgroups() ¶ public
groups(): arrayReturns the group value for each of the configured groups
If the group initial value was not found, then it initializes
the group accordingly.
Returns
arrayincrement() ¶ public
increment(string $key, int $offset = 1): bool|intIncrements the value of an integer cached key If the cache key is not an integer it will be treated as 0
Parameters
-
string$key Identifier for the data
-
int$offset optional How much to increment
Returns
bool|intinit() ¶ public
init(array $config = []): boolInitialize the Cache Engine
Called automatically by the cache frontend
Parameters
-
array$config optional array of setting for the engine
Returns
boolkey() ¶ public
key(string $key): bool|stringGenerates a safe key for use with cache engine storage engines.
Parameters
-
string$key the key passed over
Returns
bool|stringread() ¶ public
read(string $key): mixedRead a key from the cache
Parameters
-
string$key Identifier for the data
Returns
mixedreadMany() ¶ public
readMany(array $keys): arrayRead multiple keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arraysetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);Setting a nested value:
$this->setConfig('some.nested.key', $value);Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
write() ¶ public
write(string $key, mixed $value): boolWrite data for key into cache
Parameters
-
string$key Identifier for the data
-
mixed$value Data to be cached
Returns
boolwriteMany() ¶ public
writeMany(array $data): arrayWrite data for many keys into cache
Parameters
-
array$data An array of data to be stored in the cache
Returns
arrayProperty Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
The default config used unless overridden by runtime configuration
durationSpecify how long items in this cache configuration last.groupsList of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.prefixPrefix appended to all entries. Good for when you need to share a keyspace with either another cache config or another application.probabilityProbability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.PHP_AUTH_USERxcache.admin.userPHP_AUTH_PWxcache.admin.password
Type
array$_groupPrefix ¶ protected
Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine
Type
string