1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Config
  7. \
  8. StorageInterface

StorageInterface

interface StorageInterface (View source)

Defines an interface for configuration storage.

Classes implementing this interface allow reading and writing configuration data from and to the storage.

Constants

DEFAULT_COLLECTION

The default collection name.

Methods

bool
exists(string $name)

Returns whether a configuration object exists.

array|bool
read(string $name)

Reads configuration data from the storage.

array
readMultiple(array $names)

Reads configuration data from the storage.

bool
write(string $name, array $data)

Writes configuration data to the storage.

bool
delete(string $name)

Deletes a configuration object from the storage.

bool
rename(string $name, string $new_name)

Renames a configuration object in the storage.

string
encode(array $data)

Encodes configuration data into the storage-specific format.

array
decode(string $raw)

Decodes configuration data from the storage-specific format.

array
listAll(string $prefix = '')

Gets configuration object names starting with a given prefix.

bool
deleteAll(string $prefix = '')

Deletes configuration objects whose names start with a given prefix.

$this
createCollection(string $collection)

Creates a collection on the storage.

array
getAllCollectionNames()

Gets the existing collections.

string
getCollectionName()

Gets the name of the current collection the storage is using.

Details

at line 27
bool exists(string $name)

Returns whether a configuration object exists.

Parameters

string $name

The name of a configuration object to test.

Return Value

bool

TRUE if the configuration object exists, FALSE otherwise.

at line 39
array|bool read(string $name)

Reads configuration data from the storage.

Parameters

string $name

The name of a configuration object to load.

Return Value

array|bool

The configuration data stored for the configuration object name. If no configuration data exists for the given name, FALSE is returned.

at line 51
array readMultiple(array $names)

Reads configuration data from the storage.

Parameters

array $names

List of names of the configuration objects to load.

Return Value

array

A list of the configuration data stored for the configuration object name that could be loaded for the passed list of names.

at line 67
bool write(string $name, array $data)

Writes configuration data to the storage.

Parameters

string $name

The name of a configuration object to save.
array $data

The configuration data to write.

Return Value

bool

TRUE on success, FALSE in case of an error.

Exceptions

StorageException

at line 78
bool delete(string $name)

Deletes a configuration object from the storage.

Parameters

string $name

The name of a configuration object to delete.

Return Value

bool

TRUE on success, FALSE otherwise.

at line 91
bool rename(string $name, string $new_name)

Renames a configuration object in the storage.

Parameters

string $name

The name of a configuration object to rename.
string $new_name

The new name of a configuration object.

Return Value

bool

TRUE on success, FALSE otherwise.

at line 105
string encode(array $data)

Encodes configuration data into the storage-specific format.

This is a publicly accessible static method to allow for alternative usages in data conversion scripts and also tests.

Parameters

array $data

The configuration data to encode.

Return Value

string

The encoded configuration data.

at line 119
array decode(string $raw)

Decodes configuration data from the storage-specific format.

This is a publicly accessible static method to allow for alternative usages in data conversion scripts and also tests.

Parameters

string $raw

The raw configuration data string to decode.

Return Value

array

The decoded configuration data as an associative array.

at line 138
array listAll(string $prefix = '')

Gets configuration object names starting with a given prefix.

Given the following configuration objects:

  • node.type.article
  • node.type.page

Passing the prefix 'node.type.' will return an array containing the above names.

Parameters

string $prefix

(optional) The prefix to search for. If omitted, all configuration object names that exist are returned.

Return Value

array

An array containing matching configuration object names.

at line 157
bool deleteAll(string $prefix = '')

Deletes configuration objects whose names start with a given prefix.

Given the following configuration object names:

  • node.type.article
  • node.type.page

Passing the prefix 'node.type.' will delete the above configuration objects.

Parameters

string $prefix

(optional) The prefix to search for. If omitted, all configuration objects that exist will be deleted.

Return Value

bool

TRUE on success, FALSE otherwise.

at line 179
$this createCollection(string $collection)

Creates a collection on the storage.

A configuration storage can contain multiple sets of configuration objects in partitioned collections. The collection name identifies the current collection used.

Implementations of this method must provide a new instance to avoid side effects caused by the fact that Config objects have their storage injected.

Parameters

string $collection

The collection name. Valid collection names conform to the following regex [a-zA-Z_.]. A storage does not need to have a collection set. However, if a collection is set, then storage should use it to store configuration in a way that allows retrieval of configuration for a particular collection.

Return Value

$this

A new instance of the storage backend with the collection set.

at line 191
array getAllCollectionNames()

Gets the existing collections.

A configuration storage can contain multiple sets of configuration objects in partitioned collections. The collection key name identifies the current collection used.

Return Value

array

An array of existing collection names.

at line 199
string getCollectionName()

Gets the name of the current collection the storage is using.

Return Value

string

The current collection name.