function StorageInterface::createCollection

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

11 methods override StorageInterface::createCollection()
CachedStorage::createCollection in core/lib/Drupal/Core/Config/CachedStorage.php
DatabaseStorage::createCollection in core/lib/Drupal/Core/Config/DatabaseStorage.php
FileStorage::createCollection in core/lib/Drupal/Core/Config/FileStorage.php
ManagedStorage::createCollection in core/lib/Drupal/Core/Config/ManagedStorage.php
MemoryStorage::createCollection in core/lib/Drupal/Core/Config/MemoryStorage.php

... See full list

File

core/lib/Drupal/Core/Config/StorageInterface.php, line 184

Class

StorageInterface
Defines an interface for configuration storage.

Namespace

Drupal\Core\Config

Code

public function createCollection($collection);

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