1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. KeyValueStore
  7. \
  8. NullStorageExpirable

NullStorageExpirable

class NullStorageExpirable implements KeyValueStoreExpirableInterface (View source)

Defines a null key/value store implementation.

Properties

protected array $data

The actual storage of key-value pairs.
protected string $collection

The name of the collection holding key and value pairs.

Methods

__construct($collection)

Creates a new expirable null key/value store.

bool
has(string $key)

Returns whether a given key exists in the store.

mixed
get(string $key, mixed $default = NULL)

Returns the stored value for a given key.

array
getMultiple(array $keys)

Returns the stored key/value pairs for a given set of keys.

array
getAll()

Returns all stored key/value pairs in the collection.

set(string $key, mixed $value)

Saves a value for a given key.

bool
setIfNotExists(string $key, mixed $value)

Saves a value for a given key if it does not exist yet.

setMultiple(array $data)

Saves key/value pairs.

rename(string $key, string $new_key)

Renames a key.

delete(string $key)

Deletes an item from the key/value store.

deleteMultiple(array $keys)

Deletes multiple items from the key/value store.

deleteAll()

Deletes all items from the key/value store.

string
getCollectionName()

Returns the name of this collection.

setMultipleWithExpire(array $data, int $expire)

Saves an array of values with a time to live.

setWithExpire(string $key, mixed $value, int $expire)

Saves a value for a given key with a time to live.

bool
setWithExpireIfNotExists(string $key, mixed $value, int $expire)

Sets a value for a given key with a time to live if it does not yet exist.

Details

at line 27
__construct($collection)

Creates a new expirable null key/value store.

Parameters

$collection

at line 34
bool has(string $key)

Returns whether a given key exists in the store.

Parameters

string $key

The key to check.

Return Value

bool

TRUE if the key exists, FALSE otherwise.

at line 41
mixed get(string $key, mixed $default = NULL)

Returns the stored value for a given key.

Parameters

string $key

The key of the data to retrieve.
mixed $default

The default value to use if the key is not found.

Return Value

mixed

The stored value, or the default value if no value exists.

at line 48
array getMultiple(array $keys)

Returns the stored key/value pairs for a given set of keys.

Parameters

array $keys

A list of keys to retrieve.

Return Value

array

An associative array of items successfully returned, indexed by key.

at line 55
array getAll()

Returns all stored key/value pairs in the collection.

Return Value

array

An associative array containing all stored items in the collection.

at line 62
set(string $key, mixed $value)

Saves a value for a given key.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.

at line 67
bool setIfNotExists(string $key, mixed $value)

Saves a value for a given key if it does not exist yet.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.

Return Value

bool

TRUE if the data was set, FALSE if it already existed.

at line 72
setMultiple(array $data)

Saves key/value pairs.

Parameters

array $data

An associative array of key/value pairs.

at line 77
rename(string $key, string $new_key)

Renames a key.

Parameters

string $key

The key to rename.
string $new_key

The new key name.

at line 83
delete(string $key)

Deletes an item from the key/value store.

Parameters

string $key

The item name to delete.

at line 88
deleteMultiple(array $keys)

Deletes multiple items from the key/value store.

Parameters

array $keys

A list of item names to delete.

at line 93
deleteAll()

Deletes all items from the key/value store.

at line 98
string getCollectionName()

Returns the name of this collection.

Return Value

string

The name of this collection.

at line 105
setMultipleWithExpire(array $data, int $expire)

Saves an array of values with a time to live.

Parameters

array $data

An array of data to store.
int $expire

The time to live for items, in seconds.

at line 110
setWithExpire(string $key, mixed $value, int $expire)

Saves a value for a given key with a time to live.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.
int $expire

The time to live for items, in seconds.

at line 115
bool setWithExpireIfNotExists(string $key, mixed $value, int $expire)

Sets a value for a given key with a time to live if it does not yet exist.

If a key is expired it also does not exists.

Parameters

string $key

The key of the data to store.
mixed $value

The data to store.
int $expire

The time to live for items, in seconds.

Return Value

bool

TRUE if the data was set, or FALSE if it already existed.