Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\Revisions;
Chris@18: 
Chris@18: use Drupal\Core\Entity\EntityInterface;
Chris@18: use Drupal\Core\Entity\RevisionableInterface;
Chris@18: 
Chris@18: /**
Chris@18:  * Revision ID implementation for the default or latest revisions.
Chris@18:  *
Chris@18:  * @internal JSON:API maintains no PHP API since its API is the HTTP API. This
Chris@18:  *   class may change at any time and this will break any dependencies on it.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18:  * @see jsonapi.api.php
Chris@18:  */
Chris@18: class VersionByRel extends NegotiatorBase {
Chris@18: 
Chris@18:   /**
Chris@18:    * Version argument which loads the revision known to be the "working copy".
Chris@18:    *
Chris@18:    * In Drupal terms, a "working copy" is the latest revision. It may or may not
Chris@18:    * be a "default" revision. This revision is the working copy because it is
Chris@18:    * the revision to which new work will be applied. In other words, it denotes
Chris@18:    * the most recent revision which might be considered a work-in-progress.
Chris@18:    *
Chris@18:    * @var string
Chris@18:    */
Chris@18:   const WORKING_COPY = 'working-copy';
Chris@18: 
Chris@18:   /**
Chris@18:    * Version argument which loads the revision known to be the "latest version".
Chris@18:    *
Chris@18:    * In Drupal terms, the "latest version" is the latest "default" revision. It
Chris@18:    * may or may not have later revisions after it, as long as none of them are
Chris@18:    * "default" revisions. This revision is the latest version because it is the
Chris@18:    * last revision where work was considered finished. Typically, this means
Chris@18:    * that it is the most recent "published" revision.
Chris@18:    *
Chris@18:    * @var string
Chris@18:    */
Chris@18:   const LATEST_VERSION = 'latest-version';
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   protected function getRevisionId(EntityInterface $entity, $version_argument) {
Chris@18:     assert($entity instanceof RevisionableInterface);
Chris@18:     switch ($version_argument) {
Chris@18:       case static::WORKING_COPY:
Chris@18:         /* @var \Drupal\Core\Entity\RevisionableStorageInterface $entity_storage */
Chris@18:         $entity_storage = $this->entityTypeManager->getStorage($entity->getEntityTypeId());
Chris@18:         return static::ensureVersionExists($entity_storage->getLatestRevisionId($entity->id()));
Chris@18: 
Chris@18:       case static::LATEST_VERSION:
Chris@18:         // The already loaded revision will be the latest version by default.
Chris@18:         // @see \Drupal\Core\Entity\Sql\SqlContentEntityStorage::buildQuery().
Chris@18:         return $entity->getLoadedRevisionId();
Chris@18: 
Chris@18:       default:
Chris@18:         $message = sprintf('The version specifier must be either `%s` or `%s`, `%s` given.', static::LATEST_VERSION, static::WORKING_COPY, $version_argument);
Chris@18:         throw new InvalidVersionIdentifierException($message);
Chris@18:     }
Chris@18:   }
Chris@18: 
Chris@18: }