public function VersionNegotiatorInterface::getRevision in Drupal 8

Same name and namespace in other branches

9 core/modules/jsonapi/src/Revisions/VersionNegotiatorInterface.php \Drupal\jsonapi\Revisions\VersionNegotiatorInterface::getRevision()
10 core/modules/jsonapi/src/Revisions/VersionNegotiatorInterface.php \Drupal\jsonapi\Revisions\VersionNegotiatorInterface::getRevision()

Gets the identified revision.

The JSON:API module exposes revisions in terms of RFC5829. As such, the public API always refers to "versions" and "working copies" instead of "revisions". There are multiple ways to request a specific revision. For example, one might like to load a particular revision by its ID. On the other hand, it may be useful if an HTTP consumer is able to always request the "latest version" regardless of its ID. It is possible to imagine other scenarios as well, like fetching a revision based on a date or time.

Each version negotiator provides one of these strategies and is able to map a version argument to an existing revision.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity for which a revision should be resolved.

string $version_argument: A value used to derive a revision for the given entity.

Return value

\Drupal\Core\Entity\EntityInterface The identified entity revision.

Throws

\Drupal\jsonapi\Revisions\VersionNotFoundException When the revision does not exist.

\Drupal\jsonapi\Revisions\InvalidVersionIdentifierException When the revision ID is invalid.

1 method overrides VersionNegotiatorInterface::getRevision()

NegotiatorBase::getRevision in core/modules/jsonapi/src/Revisions/NegotiatorBase.php: Gets the identified revision.

File

core/modules/jsonapi/src/Revisions/VersionNegotiatorInterface.php, line 47

Class

VersionNegotiatorInterface: Defines the common interface for all version negotiators.

Namespace

Drupal\jsonapi\Revisions

Code

public function getRevision(EntityInterface $entity, $version_argument);

You are here