Cache

The cache frontend.

Properties

options

protected Map $options

useCache

protected bool $useCache

backend

protected Backend $backend

Methods

__construct

Cache object constructor.

public  __construct({Array})

Parameters

Parameter	Type	Description
$backend	string	The name of the backend to use. Currently 'apc', 'file', 'memcached', 'session' and

                                       'sqlite' are supported. |

| $configOptions | Map | | | $namespace | string | The namespace to use for grouping stored data |

__destruct

public  __destruct({Array})

__isset

public  __isset({Array})

Parameters

Parameter	Type	Description
$key	string

__set

public  __set({Array})

Parameters

Parameter	Type	Description
$key	string
$value	mixed

__unset

public  __unset({Array})

Parameters

Parameter	Type	Description
$key	string

can

public  can({Array})

Parameters

Parameter	Type	Description
$feature	string

configure

public  configure({Array})

Parameters

Parameter	Type	Description
$options	Map

getBackend

public  getBackend({Array})

setBackendOption

public  setBackendOption({Array})

Parameters

Parameter	Type	Description
$key	string
$value	mixed

lock

public  lock({Array})

Parameters

Parameter	Type	Description
$key	string

unlock

public  unlock({Array})

Parameters

Parameter	Type	Description
$key	string

get

Retrieve a value from cache storage.

public  get({Array})

Parameters

Parameter	Type	Description
$key	string	The reference key used to store the value
$default	mixed	If the value doesn't exist, this default will be returned instead
$saveDefault	bool	If the value doesn't exist and a default is specified, save that default to cache
$timeout	int

set

Store a value in the cache using the current cache backend.

public  set({Array})

Parameters

Parameter	Type	Description
$key	string	The reference key under which to store the value
$value	mixed	The value that should be stored. Values can be pretty much anything including integers, booleans,

                   strings and any object that can be serialised. |

| $timeout | int | The number of seconds after which the value becomes invalid. If not set the global 'lifetime' option is used. Set a value of '-1' to indicate that the value should never timeout. |

has

Check if a stored value exists.

public  has({Array})

Parameters

Parameter	Type	Description
$key	string	The value key to check for
$checkEmpty	bool	Normally this method will return try if the value exists with $key. Setting $checkEmpty looks at the value

                      and will return false if it is an 'empty' value (ie: 0, null, []) |

remove

Removes a stored value.

public  remove({Array})

Parameters

Parameter	Type	Description
$key	string	The key of the value to remove

extend

Extend the cache with an array of key/value pairs.

public  extend({Array})

Parameters

Parameter	Type	Description
$array	array	The array of key/value pairs to store in the cache
$recursive	bool

clear

public  clear({Array})

populate

Set multiple values in the cache.

public  populate({Array})

Parameters

Parameter	Type	Description
$values	array

pull

public  pull({Array})

Parameters

Parameter	Type	Description
$key	string

toArray

Retrieve all values from the cache.

public  toArray({Array})

count

public  count({Array})

on

Disable the use of cache.

public  on({Array})

This allows a cache object to be disabled but still be used without having to modify existing application code. The application can still call the get() method but it will always return false, simulating a negative cache response. Calling set() will still have an affect however.

off

Enable the use of cache.

public  off({Array})

Cache is enabled by default. This is to allow cache to be re-enabled after calling off().

This method can also be used to force cache back on after being disabled by a "Pragma: no-cache" header in the case where the use_pragma setting is enabled (which is the default).

__get

public  __get({Array})

Parameters

Parameter	Type	Description
$key	string

offsetExists

public  offsetExists({Array})

Parameters

Parameter	Type	Description
$offset	``````

offsetGet

public  offsetGet({Array})

Parameters

Parameter	Type	Description
$offset	``````

offsetSet

public  offsetSet({Array})

Parameters

Parameter	Type	Description
$offset	``````
$value	``````

offsetUnset

public  offsetUnset({Array})

Parameters

Parameter	Type	Description
$offset	``````

increment

Increment key value.

public  increment({Array})

This method will increment a cached integer value by a defined amount (default is 1). Once the value is incremented it will be stored back in the cache and the new value returned.

Parameters

Parameter	Type	Description
$key	string	The cache key
$amount	int	the amount to increment the value by

decrement

Decrement key value.

public  decrement({Array})

This method will decrement a cached integer value by a defined amount (default is 1). Once the value is decremented it will be stored back in the cache and the new value returned.

Parameters

Parameter	Type	Description
$key	string	The cache key
$amount	int	the amount to decrement the value by

---

Generated by Hazaar API Doc Generator