1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. State
  7. \
  8. StateInterface

StateInterface

interface StateInterface (View source)

Defines the interface for the state system.

Methods

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.

set(string $key, mixed $value)

Saves a value for a given key.

setMultiple(array $data)

Saves key/value pairs.

delete(string $key)

Deletes an item.

deleteMultiple(array $keys)

Deletes multiple items.

resetCache()

Resets the static cache.

Details

at line 23
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 NULL if no value exists.

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

Saves key/value pairs.

Parameters

array $data

An associative array of key/value pairs.

at line 60
delete(string $key)

Deletes an item.

Parameters

string $key

The item name to delete.

at line 68
deleteMultiple(array $keys)

Deletes multiple items.

Parameters

array $keys

A list of item names to delete.

at line 75
resetCache()

Resets the static cache.

This is mainly used in testing environments.