NullStorage
class NullStorage implements StorageInterface (View source)
Defines a stub storage.
This storage is always empty; the controller reads and writes nothing.
The stub implementation is needed for synchronizing configuration during installation of a module, in which case all configuration being shipped with the module is known to be new. Therefore, the module installation process is able to short-circuit the full diff against the active configuration; the diff would yield all currently available configuration as items to remove, since they do not exist in the module's default configuration directory.
This also can be used for testing purposes.
Properties
| protected string | $collection | The storage collection. |
Methods
Constructs a new NullStorage.
Returns whether a configuration object exists.
Reads configuration data from the storage.
Reads configuration data from the storage.
Writes configuration data to the storage.
Deletes a configuration object from the storage.
Renames a configuration object in the storage.
Encodes configuration data into the storage-specific format.
Decodes configuration data from the storage-specific format.
Gets configuration object names starting with a given prefix.
Deletes configuration objects whose names start with a given prefix.
Creates a collection on the storage.
Gets the existing collections.
Gets the name of the current collection the storage is using.
Details
__construct(string $collection = StorageInterface::DEFAULT_COLLECTION)
Constructs a new NullStorage.
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.
This is a publicly accessible static method to allow for alternative usages in data conversion scripts and also tests.
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.
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.
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.
$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.
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.
string
getCollectionName()
Gets the name of the current collection the storage is using.