Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\ParamConverter;
Chris@0: 
Chris@18: use Drupal\Core\Entity\EntityInterface;
Chris@0: use Drupal\Core\Entity\EntityRepositoryInterface;
Chris@0: use Drupal\Core\Entity\EntityTypeManagerInterface;
Chris@18: use Drupal\Core\Entity\TranslatableInterface;
Chris@0: use Symfony\Component\Routing\Route;
Chris@0: 
Chris@0: /**
Chris@0:  * Parameter converter for upcasting entity revision IDs to full objects.
Chris@0:  *
Chris@0:  * This is useful for pages which want to show a specific revision, like
Chris@0:  * "/entity_example/{entity_example}/revision/{entity_example_revision}".
Chris@0:  *
Chris@0:  *
Chris@0:  * In order to use it you should specify some additional options in your route:
Chris@0:  * @code
Chris@0:  * example.route:
Chris@0:  *   path: /foo/{entity_example_revision}
Chris@0:  *   options:
Chris@0:  *     parameters:
Chris@0:  *       entity_example_revision:
Chris@0:  *         type: entity_revision:entity_example
Chris@0:  * @endcode
Chris@0:  */
Chris@0: class EntityRevisionParamConverter implements ParamConverterInterface {
Chris@0: 
Chris@18:   use DynamicEntityTypeParamConverterTrait;
Chris@18: 
Chris@0:   /**
Chris@0:    * The entity type manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityTypeManagerInterface
Chris@0:    */
Chris@0:   protected $entityTypeManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The entity repository.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityRepositoryInterface
Chris@0:    */
Chris@0:   protected $entityRepository;
Chris@0: 
Chris@0:   /**
Chris@0:    * Creates a new EntityRevisionParamConverter instance.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
Chris@0:    *   The entity type manager.
Chris@0:    * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
Chris@0:    *   The entity repository.
Chris@0:    */
Chris@0:   public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository) {
Chris@0:     $this->entityTypeManager = $entity_type_manager;
Chris@0:     $this->entityRepository = $entity_repository;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function convert($value, $definition, $name, array $defaults) {
Chris@18:     $entity_type_id = $this->getEntityTypeFromDefaults($definition, $name, $defaults);
Chris@0:     $entity = $this->entityTypeManager->getStorage($entity_type_id)->loadRevision($value);
Chris@18: 
Chris@18:     // If the entity type is translatable, ensure we return the proper
Chris@18:     // translation object for the current context.
Chris@18:     if ($entity instanceof EntityInterface && $entity instanceof TranslatableInterface) {
Chris@18:       $entity = $this->entityRepository->getTranslationFromContext($entity, NULL, ['operation' => 'entity_upcast']);
Chris@18:     }
Chris@18: 
Chris@18:     return $entity;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function applies($definition, $name, Route $route) {
Chris@0:     return isset($definition['type']) && strpos($definition['type'], 'entity_revision:') !== FALSE;
Chris@0:   }
Chris@0: 
Chris@0: }