class ReadOnlyStorage in Drupal 9
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Config/ReadOnlyStorage.php \Drupal\Core\Config\ReadOnlyStorage
A ReadOnlyStorage decorates a storage and does not allow writing to it.
Hierarchy
- class \Drupal\Core\Config\ReadOnlyStorage implements StorageInterface
Expanded class hierarchy of ReadOnlyStorage
1 file declares its use of ReadOnlyStorage
- ReadOnlyStorageTest.php in core/
tests/ Drupal/ Tests/ Core/ Config/ ReadOnlyStorageTest.php
File
- core/
lib/ Drupal/ Core/ Config/ ReadOnlyStorage.php, line 8
Namespace
Drupal\Core\ConfigView source
class ReadOnlyStorage implements StorageInterface {
/**
* The config storage that we are decorating.
*
* @var \Drupal\Core\Config\StorageInterface
*/
protected $storage;
/**
* Create a ReadOnlyStorage decorating another storage.
*
* @param \Drupal\Core\Config\StorageInterface $storage
* The decorated storage.
*/
public function __construct(StorageInterface $storage) {
$this->storage = $storage;
}
/**
* {@inheritdoc}
*/
public function exists($name) {
return $this->storage
->exists($name);
}
/**
* {@inheritdoc}
*/
public function read($name) {
return $this->storage
->read($name);
}
/**
* {@inheritdoc}
*/
public function readMultiple(array $names) {
return $this->storage
->readMultiple($names);
}
/**
* {@inheritdoc}
*/
public function write($name, array $data) {
throw new \BadMethodCallException(__METHOD__ . ' is not allowed on a ReadOnlyStorage');
}
/**
* {@inheritdoc}
*/
public function delete($name) {
throw new \BadMethodCallException(__METHOD__ . ' is not allowed on a ReadOnlyStorage');
}
/**
* {@inheritdoc}
*/
public function rename($name, $new_name) {
throw new \BadMethodCallException(__METHOD__ . ' is not allowed on a ReadOnlyStorage');
}
/**
* {@inheritdoc}
*/
public function encode($data) {
return $this->storage
->encode($data);
}
/**
* {@inheritdoc}
*/
public function decode($raw) {
return $this->storage
->decode($raw);
}
/**
* {@inheritdoc}
*/
public function listAll($prefix = '') {
return $this->storage
->listAll($prefix);
}
/**
* {@inheritdoc}
*/
public function deleteAll($prefix = '') {
throw new \BadMethodCallException(__METHOD__ . ' is not allowed on a ReadOnlyStorage');
}
/**
* {@inheritdoc}
*/
public function createCollection($collection) {
return new static($this->storage
->createCollection($collection));
}
/**
* {@inheritdoc}
*/
public function getAllCollectionNames() {
return $this->storage
->getAllCollectionNames();
}
/**
* {@inheritdoc}
*/
public function getCollectionName() {
return $this->storage
->getCollectionName();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ReadOnlyStorage:: |
protected | property | The config storage that we are decorating. | |
ReadOnlyStorage:: |
public | function |
Creates a collection on the storage. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Decodes configuration data from the storage-specific format. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Deletes a configuration object from the storage. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Deletes configuration objects whose names start with a given prefix. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Encodes configuration data into the storage-specific format. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Returns whether a configuration object exists. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Gets the existing collections. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Gets the name of the current collection the storage is using. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Gets configuration object names starting with a given prefix. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Reads configuration data from the storage. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Reads configuration data from the storage. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Renames a configuration object in the storage. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function |
Writes configuration data to the storage. Overrides StorageInterface:: |
|
ReadOnlyStorage:: |
public | function | Create a ReadOnlyStorage decorating another storage. | |
StorageInterface:: |
constant | The default collection name. |