function ManagedStorage::createCollection

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Config/ManagedStorage.php \Drupal\Core\Config\ManagedStorage::createCollection()
  2. 8.9.x core/lib/Drupal/Core/Config/ManagedStorage.php \Drupal\Core\Config\ManagedStorage::createCollection()
  3. 11.x core/lib/Drupal/Core/Config/ManagedStorage.php \Drupal\Core\Config\ManagedStorage::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.

Overrides StorageInterface::createCollection

File

core/lib/Drupal/Core/Config/ManagedStorage.php, line 115

Class

ManagedStorage
The managed storage defers all the storage method calls to the manager.

Namespace

Drupal\Core\Config

Code

public function createCollection($collection) {
    // We return the collection directly.
    // This means that the collection will not be an instance of ManagedStorage
    // But this doesn't matter because the storage is retrieved from the
    // manager only the first time it is accessed.
    return $this->getStorage()
        ->createCollection($collection);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.