function CheckpointStorageInterface::setCheckpointToReadFrom

Same name in other branches
  1. 11.x core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorageInterface.php \Drupal\Core\Config\Checkpoint\CheckpointStorageInterface::setCheckpointToReadFrom()

Sets the checkpoint to read from.

Calling read() or readMultiple() will return the configuration data at the time of the checkpoint that was set here. If none is set, then the configuration from the initial checkpoint will be returned.

Parameters

string|\Drupal\Core\Config\Checkpoint\Checkpoint $checkpoint_id: The checkpoint ID to read from.

Return value

$this

Throws

\Drupal\Core\Config\Checkpoint\UnknownCheckpointException Thrown when the provided checkpoint does not exist.

File

core/lib/Drupal/Core/Config/Checkpoint/CheckpointStorageInterface.php, line 46

Class

CheckpointStorageInterface
Provides an interface for checkpoint storages.

Namespace

Drupal\Core\Config\Checkpoint

Code

public function setCheckpointToReadFrom(string|Checkpoint $checkpoint_id) : static;

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