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

KeyValueStoreInterface

interface KeyValueStoreInterface (View source)

Defines the interface for key/value store implementations.

Methods

string
getCollectionName()

Returns the name of this collection.

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.

Details

at line 16
string getCollectionName()

Returns the name of this collection.

Return Value

string

The name of this collection.

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.

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.

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.

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.

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.

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.

at line 93
setMultiple(array $data)

Saves key/value pairs.

Parameters

array $data

An associative array of key/value pairs.

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.

at line 111
delete(string $key)

Deletes an item from the key/value store.

Parameters

string $key

The item name to delete.

at line 119
deleteMultiple(array $keys)

Deletes multiple items from the key/value store.

Parameters

array $keys

A list of item names to delete.

at line 124
deleteAll()

Deletes all items from the key/value store.