function CheckpointStorage::createCollection

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorage.php \Drupal\Core\Config\Checkpoint\CheckpointStorage::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/Checkpoint/CheckpointStorage.php, line 214

Class

CheckpointStorage
Provides a config storage that can make checkpoints.

Namespace

Drupal\Core\Config\Checkpoint

Code

public function createCollection($collection) {
  $collection = new self($this->activeStorage
    ->createCollection($collection), $this->checkpoints, $this->keyValueFactory, $collection);
  // \Drupal\Core\Config\Checkpoint\CheckpointStorage::$readFromCheckpoint is
  // assigned by reference so that it is  consistent across all collection
  // objects created from the same initial object.
  $collection->readFromCheckpoint =& $this->readFromCheckpoint;
  return $collection;
}

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