class VersionById

Defines a revision ID implementation for entity revision ID values.

@internal JSON:API maintains no PHP API since its API is the HTTP API. This class may change at any time and this will break any dependencies on it.

Hierarchy

• class \Drupal\jsonapi\Revisions\NegotiatorBase implements \Drupal\jsonapi\Revisions\VersionNegotiatorInterface
  • class \Drupal\jsonapi\Revisions\VersionById implements \Drupal\jsonapi\Revisions\VersionNegotiatorInterface extends \Drupal\jsonapi\Revisions\NegotiatorBase

Expanded class hierarchy of VersionById

See also

https://www.drupal.org/project/drupal/issues/3032787

jsonapi.api.php

File

core/modules/jsonapi/src/Revisions/VersionById.php, line 16

Namespace

class VersionById extends NegotiatorBase implements VersionNegotiatorInterface {
  
  /**
   * {@inheritdoc}
   */
  protected function getRevisionId(EntityInterface $entity, $version_argument) {
    if (!is_numeric($version_argument)) {
      throw new InvalidVersionIdentifierException('The revision ID must be an integer.');
    }
    return $version_argument;
  }

}