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

StorageBase

abstract class StorageBase implements KeyValueStoreInterface (View source)

Provides a base class for key/value storage implementations.

Properties

protected string $collection

The name of the collection holding key and value pairs.

Methods

__construct($collection)

{@inheritdoc}

string
getCollectionName()

Returns the name of this collection.

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

Returns the stored value for a given key.

setMultiple(array $data)

Saves key/value pairs.

delete(string $key)

Deletes an item from the key/value store.

Details

at line 20
__construct($collection)

{@inheritdoc}

Parameters

$collection

at line 27
string getCollectionName()

Returns the name of this collection.

Return Value

string

The name of this collection.

at line 34
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 42
setMultiple(array $data)

Saves key/value pairs.

Parameters

array $data

An associative array of key/value pairs.

at line 51
delete(string $key)

Deletes an item from the key/value store.

Parameters

string $key

The item name to delete.