Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Core\ParamConverter;
Chris@0: 
Chris@18: use Drupal\Core\Config\ConfigFactoryInterface;
Chris@0: use Drupal\Core\Config\Entity\ConfigEntityInterface;
Chris@18: use Drupal\Core\Entity\EntityTypeManagerInterface;
Chris@0: use Drupal\Core\Routing\AdminContext;
Chris@0: use Symfony\Component\Routing\Route;
Chris@0: 
Chris@0: /**
Chris@0:  * Makes sure the unmodified ConfigEntity is loaded on admin pages.
Chris@0:  *
Chris@0:  * Converts entity route arguments to unmodified entities as opposed to
Chris@0:  * converting to entities with overrides, such as the negotiated language.
Chris@0:  *
Chris@0:  * This converter applies only if the path is an admin path, the entity is
Chris@0:  * a config entity, and the "with_config_overrides" element is not set to TRUE
Chris@0:  * on the parameter definition.
Chris@0:  *
Chris@0:  * Due to this converter having a higher weight than the default
Chris@0:  * EntityConverter, every time this applies, it takes over the conversion duty
Chris@0:  * from EntityConverter. As we only allow a single converter per route
Chris@0:  * argument, EntityConverter is ignored when this converter applies.
Chris@0:  */
Chris@0: class AdminPathConfigEntityConverter extends EntityConverter {
Chris@0: 
Chris@0:   /**
Chris@0:    * The config factory.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Config\ConfigFactoryInterface
Chris@0:    */
Chris@0:   protected $configFactory;
Chris@0: 
Chris@0:   /**
Chris@0:    * The route admin context to determine whether a route is an admin one.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Routing\AdminContext
Chris@0:    */
Chris@0:   protected $adminContext;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new EntityConverter.
Chris@0:    *
Chris@18:    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
Chris@18:    *   The entity type manager.
Chris@0:    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
Chris@0:    *   The config factory.
Chris@0:    * @param \Drupal\Core\Routing\AdminContext $admin_context
Chris@0:    *   The route admin context service.
Chris@18:    * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
Chris@18:    *   The entity repository.
Chris@0:    */
Chris@18:   public function __construct(EntityTypeManagerInterface $entity_type_manager, ConfigFactoryInterface $config_factory, AdminContext $admin_context, $entity_repository = NULL) {
Chris@18:     parent::__construct($entity_type_manager, $entity_repository);
Chris@0: 
Chris@0:     $this->configFactory = $config_factory;
Chris@0:     $this->adminContext = $admin_context;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function convert($value, $definition, $name, array $defaults) {
Chris@0:     $entity_type_id = $this->getEntityTypeFromDefaults($definition, $name, $defaults);
Chris@0: 
Chris@0:     // If the entity type is dynamic, confirm it to be a config entity. Static
Chris@0:     // entity types will have performed this check in self::applies().
Chris@0:     if (strpos($definition['type'], 'entity:{') === 0) {
Chris@18:       $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
Chris@0:       if (!$entity_type->entityClassImplements(ConfigEntityInterface::class)) {
Chris@0:         return parent::convert($value, $definition, $name, $defaults);
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@18:     if ($storage = $this->entityTypeManager->getStorage($entity_type_id)) {
Chris@0:       // Make sure no overrides are loaded.
Chris@0:       return $storage->loadOverrideFree($value);
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function applies($definition, $name, Route $route) {
Chris@0:     if (isset($definition['with_config_overrides']) && $definition['with_config_overrides']) {
Chris@0:       return FALSE;
Chris@0:     }
Chris@0: 
Chris@0:     if (parent::applies($definition, $name, $route)) {
Chris@0:       $entity_type_id = substr($definition['type'], strlen('entity:'));
Chris@0:       // If the entity type is dynamic, defer checking to self::convert().
Chris@0:       if (strpos($entity_type_id, '{') === 0) {
Chris@0:         return TRUE;
Chris@0:       }
Chris@0:       // As we only want to override EntityConverter for ConfigEntities, find
Chris@0:       // out whether the current entity is a ConfigEntity.
Chris@18:       $entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
Chris@0:       if ($entity_type->entityClassImplements(ConfigEntityInterface::class)) {
Chris@0:         return $this->adminContext->isAdminRoute($route);
Chris@0:       }
Chris@0:     }
Chris@0:     return FALSE;
Chris@0:   }
Chris@0: 
Chris@0: }