\Psr\SimpleCacheCacheInterface

Summary

Methods
Constants
get()
set()
delete()
clear()
getMultiple()
setMultiple()
deleteMultiple()
has()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

get()

get(string  $key, mixed  $default = null) : mixed

Fetches a value from the cache.

Parameters

string $key

The unique key of this item in the cache.

mixed $default

Default value to return if the key does not exist.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if the $key string is not a legal value.

Returns

mixed —

The value of the item from the cache, or $default in case of cache miss.

set()

set(string  $key, mixed  $value, null|int|\DateInterval  $ttl = null) : bool

Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

Parameters

string $key

The key of the item to store.

mixed $value

The value of the item to store, must be serializable.

null|int|\DateInterval $ttl

Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if the $key string is not a legal value.

Returns

bool —

True on success and false on failure.

delete()

delete(string  $key) : bool

Delete an item from the cache by its unique key.

Parameters

string $key

The unique cache key of the item to delete.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if the $key string is not a legal value.

Returns

bool —

True if the item was successfully removed. False if there was an error.

clear()

clear() : bool

Wipes clean the entire cache's keys.

Returns

bool —

True on success and false on failure.

getMultiple()

getMultiple(iterable  $keys, mixed  $default = null) : iterable

Obtains multiple cache items by their unique keys.

Parameters

iterable $keys

A list of keys that can obtained in a single operation.

mixed $default

Default value to return for keys that do not exist.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

Returns

iterable —

A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.

setMultiple()

setMultiple(iterable  $values, null|int|\DateInterval  $ttl = null) : bool

Persists a set of key => value pairs in the cache, with an optional TTL.

Parameters

iterable $values

A list of key => value pairs for a multiple-set operation.

null|int|\DateInterval $ttl

Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if $values is neither an array nor a Traversable, or if any of the $values are not a legal value.

Returns

bool —

True on success and false on failure.

deleteMultiple()

deleteMultiple(iterable  $keys) : bool

Deletes multiple cache items in a single operation.

Parameters

iterable $keys

A list of string-based keys to be deleted.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if $keys is neither an array nor a Traversable, or if any of the $keys are not a legal value.

Returns

bool —

True if the items were successfully removed. False if there was an error.

has()

has(string  $key) : bool

Determines whether an item is present in the cache.

NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.

Parameters

string $key

The cache item key.

Throws

\Psr\SimpleCache\InvalidArgumentException

MUST be thrown if the $key string is not a legal value.

Returns

bool —