The cache frontend.
protected bool $useCache = true
protected Backend $backend
Cache object constructor.
public __construct(string $backend, array $configOptions = [], string $namespace = 'default'): void
| Parameter | Type | Description |
|---|
$backend | string | The name of the backend to use. Currently 'apc', 'file', 'memcached', 'session' and |
'sqlite' are supported. |
| $configOptions | array | | | $namespace | string | The namespace to use for grouping stored data |
public __destruct(): void
public __isset(string $key): bool
| Parameter | Type | Description |
|---|
$key | string | |
public __set(string $key, mixed $value): void
| Parameter | Type | Description |
|---|
$key | string | |
$value | mixed | |
public __unset(string $key): void
| Parameter | Type | Description |
|---|
$key | string | |
public can(string $feature): bool
| Parameter | Type | Description |
|---|
$feature | string | |
public configure(array $options): void
| Parameter | Type | Description |
|---|
$options | array | |
public getBackend(): Backend
public setBackendOption(string $key, mixed $value): void
| Parameter | Type | Description |
|---|
$key | string | |
$value | mixed | |
public lock(string $key): bool
| Parameter | Type | Description |
|---|
$key | string | |
public unlock(string $key): bool
| Parameter | Type | Description |
|---|
$key | string | |
Retrieve a value from cache storage.
public get(string $key, mixed $default, bool $saveDefault = false, int $timeout = 0): mixed
| 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 | |
Store a value in the cache using the current cache backend.
public set(string $key, mixed $value, int $timeout = 0): bool
| 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. |
Check if a stored value exists.
public has(string $key, bool $checkEmpty = false): bool
| 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, []) |
Removes a stored value.
public remove(string $key): void
| Parameter | Type | Description |
|---|
$key | string | The key of the value to remove |
Extend the cache with an array of key/value pairs.
public extend(array $array, bool $recursive = false): bool
| Parameter | Type | Description |
|---|
$array | array | The array of key/value pairs to store in the cache |
$recursive | bool | |
Set multiple values in the cache.
public populate(array $values): bool
| Parameter | Type | Description |
|---|
$values | array | |
public pull(string $key): mixed
| Parameter | Type | Description |
|---|
$key | string | |
Retrieve all values from the cache.
Disable the use of cache.
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.
Enable the use of cache.
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).
public __get(string $key): mixed
| Parameter | Type | Description |
|---|
$key | string | |
public offsetExists( $offset): bool
| Parameter | Type | Description |
|---|
$offset | `````` | |
public offsetGet( $offset): mixed
| Parameter | Type | Description |
|---|
$offset | `````` | |
public offsetSet( $offset, $value): void
| Parameter | Type | Description |
|---|
$offset | `````` | |
$value | `````` | |
public offsetUnset( $offset): void
| Parameter | Type | Description |
|---|
$offset | `````` | |
Increment key value.
public increment(string $key, int $amount = 1): int
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.
| Parameter | Type | Description |
|---|
$key | string | The cache key |
$amount | int | the amount to increment the value by |
Decrement key value.
public decrement(string $key, int $amount = 1): int
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.
| Parameter | Type | Description |
|---|
$key | string | The cache key |
$amount | int | the amount to decrement the value by |
Generated by Hazaar API Doc Generator
