You are here

Home » API reference » GraphQL 8.3 » RouteEntity.php

class RouteEntity in GraphQL 8.3

Retrieve the current routes entity, if it is an entity route.

Plugin annotation


@GraphQLField(
  id = "route_entity",
  secure = true,
  name = "entity",
  description = @Translation("The entity belonging to the current url."),
  response_cache_contexts={"languages:language_content"},
  parents = {"EntityCanonicalUrl"},
  contextual_arguments={"language"},
  type = "Entity"
)

Hierarchy

Expanded class hierarchy of RouteEntity

File

modules/graphql_core/src/Plugin/GraphQL/Fields/Routing/RouteEntity.php, line 36

Namespace

Drupal\graphql_core\Plugin\GraphQL\Fields\Routing
View source 
class RouteEntity extends FieldPluginBase implements ContainerFactoryPluginInterface {
  use DependencySerializationTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The entity repository service.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
    return new static($configuration, $pluginId, $pluginDefinition, $container
      ->get('entity_type.manager'), $container
      ->get('entity.repository'), $container
      ->get('language_manager'));
  }

  /**
   * RouteEntity constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition array.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager service.
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, EntityTypeManagerInterface $entityTypeManager, EntityRepositoryInterface $entityRepository, LanguageManagerInterface $languageManager) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->entityTypeManager = $entityTypeManager;
    $this->languageManager = $languageManager;
    $this->entityRepository = $entityRepository;
  }

  /**
   * {@inheritdoc}
   */
  public function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    if ($value instanceof Url) {
      list(, $type) = explode('.', $value
        ->getRouteName());
      $parameters = $value
        ->getRouteParameters();
      $storage = $this->entityTypeManager
        ->getStorage($type);
      if (!($entity = $storage
        ->load($parameters[$type]))) {
        return $this
          ->resolveMissingEntity($value, $args, $info);
      }
      if ($entity instanceof TranslatableInterface && $entity
        ->isTranslatable()) {
        return $this
          ->resolveEntityTranslation($entity, $value, $args, $info);
      }
      return $this
        ->resolveEntity($entity, $value, $args, $info);
    }
  }

  /**
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to resolve.
   * @param \Drupal\Core\Url $url
   *   The url of the entity to resolve.
   * @param array $args
   *   The field arguments array.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Generator
   */
  protected function resolveEntity(EntityInterface $entity, Url $url, array $args, ResolveInfo $info) {
    $access = $entity
      ->access('view', NULL, TRUE);
    if ($access
      ->isAllowed()) {
      (yield $entity
        ->addCacheableDependency($access));
    }
    else {
      (yield new CacheableValue(NULL, [
        $access,
      ]));
    }
  }

  /**
   * Resolves the entity translation from the given url context.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to resolve.
   * @param \Drupal\Core\Url $url
   *   The url of the entity to resolve.
   * @param array $args
   *   The field arguments array.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Iterator
   */
  protected function resolveEntityTranslation(EntityInterface $entity, Url $url, array $args, ResolveInfo $info) {
    if ($entity instanceof TranslatableInterface && isset($args['language']) && $entity
      ->isTranslatable()) {
      if ($entity
        ->hasTranslation($args['language'])) {
        $entity = $entity
          ->getTranslation($args['language']);
      }
    }
    return $this
      ->resolveEntity($entity, $url, $args, $info);
  }

  /**
   * m
   *
   * @param \Drupal\Core\Url $url
   *   The url of the entity to resolve.
   * @param array $args
   *   The field arguments array.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Generator
   */
  protected function resolveMissingEntity(Url $url, $args, $info) {
    (yield (new CacheableValue(NULL))
      ->addCacheTags([
      '4xx-response',
    ]));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentAwarePluginTrait::buildArgumentDefault protected function Builds an argument's default value.
ArgumentAwarePluginTrait::buildArgumentDescription protected function Builds an argument's description.
ArgumentAwarePluginTrait::buildArguments protected function Builds the list of arguments.
ArgumentAwarePluginTrait::buildArgumentType protected function Builds an argument's type.
CacheablePluginTrait::buildCacheContexts protected function
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeprecatablePluginTrait::buildDeprecationReason protected function
DescribablePluginTrait::buildDescription protected function
FieldPluginBase::$isLanguageAware protected property Static cache for `isLanguageAwareField()`
FieldPluginBase::$languageContext protected property The language context service.
FieldPluginBase::$renderer protected property The renderer service. 1
FieldPluginBase::createInstance public static function Overrides FieldPluginInterface::createInstance
FieldPluginBase::getCacheDependencies protected function Retrieve the list of cache dependencies for a given value and arguments. 1
FieldPluginBase::getDefinition public function Returns the plugin's type or field definition for the schema. Overrides FieldPluginInterface::getDefinition
FieldPluginBase::getLanguageContext protected function Get the language context instance.
FieldPluginBase::getRenderer protected function Get the renderer service.
FieldPluginBase::isLanguageAwareField protected function Indicator if the field is language aware. 1
FieldPluginBase::resolve public function 1
FieldPluginBase::resolveDeferred protected function
FieldPluginBase::unwrapResult protected function Unwrap the resolved values.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
RouteEntity::$entityRepository protected property The entity repository service.
RouteEntity::$entityTypeManager protected property The entity type manager.
RouteEntity::$languageManager protected property The language manager.
RouteEntity::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RouteEntity::resolveEntity protected function
RouteEntity::resolveEntityTranslation protected function Resolves the entity translation from the given url context.
RouteEntity::resolveMissingEntity protected function m
RouteEntity::resolveValues public function Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
RouteEntity::__construct public function RouteEntity constructor. Overrides PluginBase::__construct
TypedPluginTrait::buildType protected function