1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. KeyValueStore
  7. \
  8. KeyValueStoreExpirableInterface

KeyValueStoreExpirableInterface

interface KeyValueStoreExpirableInterface implements KeyValueStoreInterface (View source)

Defines the interface for expiring data in a key/value store.

Methods

string
getCollectionName()

Returns the name of this collection.

from  KeyValueStoreInterface
bool
has(string $key)

Returns whether a given key exists in the store.

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

Returns the stored value for a given key.

from  KeyValueStoreInterface
array
getMultiple(array $keys)

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

from  KeyValueStoreInterface
array
getAll()

Returns all stored key/value pairs in the collection.

from  KeyValueStoreInterface
set(string $key, mixed $value)

Saves a value for a given key.

from  KeyValueStoreInterface
bool
setIfNotExists(string $key, mixed $value)

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

from  KeyValueStoreInterface
setMultiple(array $data)

Saves key/value pairs.

from  KeyValueStoreInterface
rename(string $key, string $new_key)

Renames a key.

from  KeyValueStoreInterface
delete(string $key)

Deletes an item from the key/value store.

from  KeyValueStoreInterface
deleteMultiple(array $keys)

Deletes multiple items from the key/value store.

from  KeyValueStoreInterface
deleteAll()

Deletes all items from the key/value store.

from  KeyValueStoreInterface
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.

setMultipleWithExpire(array $data, int $expire)

Saves an array of values with a time to live.

Details

in KeyValueStoreInterface at line 16
string getCollectionName()

Returns the name of this collection.

Return Value

string

The name of this collection.

in KeyValueStoreInterface at line 27
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.

in KeyValueStoreInterface at line 40
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.

in KeyValueStoreInterface at line 54
array getMultiple(array $keys)

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

Determine the best return value for non-existing keys in https://www.drupal.org/node/2787737

Parameters

array $keys

A list of keys to retrieve.

Return Value

array

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

in KeyValueStoreInterface at line 62
array getAll()

Returns all stored key/value pairs in the collection.

Return Value

array

An associative array containing all stored items in the collection.

in KeyValueStoreInterface at line 72
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.

in KeyValueStoreInterface at line 85
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.

in KeyValueStoreInterface at line 93
setMultiple(array $data)

Saves key/value pairs.

Parameters

array $data

An associative array of key/value pairs.

in KeyValueStoreInterface at line 103
rename(string $key, string $new_key)

Renames a key.

Parameters

string $key

The key to rename.
string $new_key

The new key name.

in KeyValueStoreInterface at line 111
delete(string $key)

Deletes an item from the key/value store.

Parameters

string $key

The item name to delete.

in KeyValueStoreInterface at line 119
deleteMultiple(array $keys)

Deletes multiple items from the key/value store.

Parameters

array $keys

A list of item names to delete.

in KeyValueStoreInterface at line 124
deleteAll()

Deletes all items from the key/value store.

at line 20
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 37
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.

at line 47
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.