annotate core/modules/jsonapi/src/Revisions/VersionById.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@18 1 <?php
Chris@18 2
Chris@18 3 namespace Drupal\jsonapi\Revisions;
Chris@18 4
Chris@18 5 use Drupal\Core\Entity\EntityInterface;
Chris@18 6
Chris@18 7 /**
Chris@18 8 * Defines a revision ID implementation for entity revision ID values.
Chris@18 9 *
Chris@18 10 * @internal JSON:API maintains no PHP API since its API is the HTTP API. This
Chris@18 11 * class may change at any time and this will break any dependencies on it.
Chris@18 12 *
Chris@18 13 * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18 14 * @see jsonapi.api.php
Chris@18 15 */
Chris@18 16 class VersionById extends NegotiatorBase implements VersionNegotiatorInterface {
Chris@18 17
Chris@18 18 /**
Chris@18 19 * {@inheritdoc}
Chris@18 20 */
Chris@18 21 protected function getRevisionId(EntityInterface $entity, $version_argument) {
Chris@18 22 if (!is_numeric($version_argument)) {
Chris@18 23 throw new InvalidVersionIdentifierException('The revision ID must be an integer.');
Chris@18 24 }
Chris@18 25 return $version_argument;
Chris@18 26 }
Chris@18 27
Chris@18 28 }