Class XcacheEngine

Xcache storage engine for cache

Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait

Cake\Cache\Engine\XcacheEngine

Namespace: Cake\Cache\Engine
Link: Xcache
Location: Cache/Engine/XcacheEngine.php

Properties summary

$_defaultConfig protected

array
The default config used unless overridden by runtime configuration

Inherited Properties

_groupPrefix _config, _configInitialized

Method Summary

_auth() protected

Populates and reverses $_SERVER authentication values Makes necessary changes (and reverting them back) in $_SERVER
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.
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
groups() public

Returns the group value for 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
read() public
Read a key from the cache
write() public
Write data for key into cache

Method Detail

_auth()source protected

_auth( boolean $reverse false )

Populates 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

boolean $reverse optional false: Revert changes

clear()source public

clear( boolean $check )

Delete all keys from the cache

Parameters

boolean $check: If true no deletes will occur and instead CakePHP will rely on key TTL values. Unused for Xcache engine.

Returns

boolean
True if the cache was successfully cleared, false otherwise

clearGroup()source public

clearGroup( string $group )

Increments 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

boolean
success

Overrides

Cake\Cache\CacheEngine::clearGroup()

decrement()source public

decrement( string $key , integer $offset 1 )

Decrements 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
integer $offset optional 1: How much to subtract

Returns

boolean|integer
New decremented value, false otherwise

delete()source public

delete( string $key )

Delete a key from the cache

Parameters

string $key: Identifier for the data

Returns

boolean
True if the value was successfully deleted, false if it didn't exist or couldn't be removed

groups()source public

groups( )

Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.

Returns

array

Overrides

Cake\Cache\CacheEngine::groups()

increment()source public

increment( string $key , integer $offset 1 )

Increments 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
integer $offset optional 1: How much to increment

Returns

boolean|integer
New incremented value, false otherwise

init()source public

init( array $config [] )

Initialize the Cache Engine

Called automatically by the cache frontend

Parameters

array $config optional []: array of setting for the engine

Returns

boolean
True if the engine has been successfully initialized, false if not

Overrides

Cake\Cache\CacheEngine::init()

read()source public

read( string $key )

Read a key from the cache

Parameters

string $key: Identifier for the data

Returns

mixed

The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it

write()source public

write( string $key , mixed $value )

Write data for key into cache

Parameters

string $key: Identifier for the data
mixed $value: Data to be cached

Returns

boolean
True if the data was successfully cached, false on failure

Methods inherited from Cake\Cache\CacheEngine

_key()source protected

_key( string $key )

Generates a safe key, taking account of the configured key prefix

Parameters

string $key: the key passed over

Returns

mixed
string $key or false

Throws

InvalidArgumentException
If key's value is empty

add()source public

add( string $key , mixed $value )

Add 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

boolean
True if the data was successfully cached, false on failure.

deleteMany()source public

deleteMany( array $keys )

Deletes keys from the cache

Parameters

array $keys: An array of identifiers for the data

Returns

array

For each provided cache key (given back as the array key) true if the value was successfully deleted, false if it didn't exist or couldn't be removed

gc()source public

gc( integer|null $expires null )

Garbage collection

Permanently remove all expired and deleted data

Parameters

integer|null $expires optional null: [optional] An expires timestamp, invalidating all data before.

key()source public

key( string $key )

Generates a safe key for use with cache engine storage engines.

Parameters

string $key: the key passed over

Returns

boolean|string
string key or false

readMany()source public

readMany( array $keys )

Read multiple keys from the cache

Parameters

array $keys: An array of identifiers for the data

Returns

array

For each cache key (given as the array key) the cache data associated or false if the data doesn't exist, has expired, or if there was an error fetching it

writeMany()source public

writeMany( array $data )

Write data for many keys into cache

Parameters

array $data: An array of data to be stored in the cache

Returns

array
of bools for each key provided, true if the data was successfully cached, false on failure

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key: Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Writes a config key.

Parameters

string|array $key: Key to write to.
mixed $value: Value to write.
boolean|string $merge optional false: True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

Gets/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']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null: The key to get/set, or a complete array of configs.
mixed|null $value optional null: The value to set.
boolean $merge optional true: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source public

configShallow( string|array $key , mixed|null $value null )

Merge 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 null: The value to set.

Returns

$this

getConfig()source public

getConfig( string|null $key null , mixed $default null )

Returns 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');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional null: The key to get or null for the whole config.
mixed $default optional null: The return value when the key does not exist.

Returns

mixed
Config value being read.

setConfig()source public

setConfig( string|array $key , mixed|null $value null , boolean $merge true )

Sets 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 null: The value to set.
boolean $merge optional true: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Properties detail

$_defaultConfigsource

protected array

The default config used unless overridden by runtime configuration

duration Specify how long items in this cache configuration last.
groups List of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.
prefix Prefix appended to all entries. Good for when you need to share a keyspace with either another cache config or another application.
probability Probability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.
PHP_AUTH_USER xcache.admin.user
PHP_AUTH_PW xcache.admin.password

[
    'duration' => 3600,
    'groups' => [],
    'prefix' => null,
    'probability' => 100,
    'PHP_AUTH_USER' => 'user',
    'PHP_AUTH_PW' => 'password'
]

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Cache.Engine.XcacheEngine.html