Class WincacheEngine
Wincache storage engine for cache
Supports wincache 1.1.0 and higher.
- Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait
-
Cake\Cache\Engine\WincacheEngine
Method Detail
clearsource public
clear( boolean $check )
Delete all keys from the cache. This will clear every item in the cache matching the cache config prefix.
Parameters
- boolean
$check
- If true, nothing will be cleared, as entries will naturally expire in wincache..
Returns
boolean
True Returns true.
clearGroupsource 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()
decrementsource public
decrement( string $key , integer $offset 1 )
Decrements the value of an integer cached key
Parameters
- string
$key
- Identifier for the data
- integer
$offset
optional 1 - How much to subtract
Returns
boolean|integer
New decremented value, false otherwise
deletesource 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
groupssource 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
array
Overrides
Cake\Cache\CacheEngine::groups()
incrementsource public
increment( string $key , integer $offset 1 )
Increments the value of an integer cached key
Parameters
- string
$key
- Identifier for the data
- integer
$offset
optional 1 - How much to increment
Returns
boolean|integer
New incremented value, false otherwise
initsource 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()
readsource 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
writesource 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
_keysource 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
addsource 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.
deleteManysource 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
gcsource 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.
keysource 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
readManysource 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
writeManysource 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
_configDeletesource protected
_configDelete( string $key )
Delete a single config key
Parameters
- string
$key
- Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configReadsource protected
_configRead( string|null $key )
Read a config variable
Parameters
- string|null
$key
- Key to read.
Returns
mixed
mixed
_configWritesource protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
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
configsource public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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 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.
configShallowsource 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->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
$key
- The key to set, or a complete array of configs.
- mixed|null
$value
optional null - The value to set.
Returns
mixed
$this The object itself.
Properties summary
Properties inherited from Cake\Cache\CacheEngine
$_defaultConfigsource
protected array
The default cache configuration is overridden in most cache adapters. These are the keys that are common to all adapters. If overridden, this property is not used.
-
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.
[ 'duration' => 3600, 'groups' => [], 'prefix' => 'cake_', 'probability' => 100 ]
$_groupPrefixsource
protected string
Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine
null
Properties used from Cake\Core\InstanceConfigTrait
$_configInitializedsource
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Cache.Engine.WincacheEngine.html