function StorageInterface::createCollection
Same name in other branches
- 9 core/lib/Drupal/Core/Config/StorageInterface.php \Drupal\Core\Config\StorageInterface::createCollection()
- 8.9.x core/lib/Drupal/Core/Config/StorageInterface.php \Drupal\Core\Config\StorageInterface::createCollection()
- 10 core/lib/Drupal/Core/Config/StorageInterface.php \Drupal\Core\Config\StorageInterface::createCollection()
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.
13 methods override StorageInterface::createCollection()
- AllowListConfigStorage::createCollection in core/
lib/ Drupal/ Core/ Recipe/ AllowListConfigStorage.php - Creates a collection on the storage.
- CachedStorage::createCollection in core/
lib/ Drupal/ Core/ Config/ CachedStorage.php - Creates a collection on the storage.
- CheckpointStorage::createCollection in core/
lib/ Drupal/ Core/ Config/ Checkpoint/ CheckpointStorage.php - Creates a collection on the storage.
- DatabaseStorage::createCollection in core/
lib/ Drupal/ Core/ Config/ DatabaseStorage.php - Creates a collection on the storage.
- FileStorage::createCollection in core/
lib/ Drupal/ Core/ Config/ FileStorage.php - Creates a collection on the storage.
File
-
core/
lib/ Drupal/ Core/ Config/ StorageInterface.php, line 184
Class
- StorageInterface
- Defines an interface for configuration storage.
Namespace
Drupal\Core\ConfigCode
public function createCollection($collection);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.