You are here

Home » API reference » GraphQL 8.3 » EntityById.php

class EntityById in GraphQL 8.3

Plugin annotation


@GraphQLField(
  id = "entity_by_id",
  secure = true,
  arguments = {
    "id" = "String!"
  },
  contextual_arguments = {"language"},
  deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityByIdDeriver"
)

Hierarchy

Expanded class hierarchy of EntityById

File

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityById.php, line 28

Namespace

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

  /**
   * The entity buffer service.
   *
   * @var \Drupal\graphql\GraphQL\Buffers\EntityBuffer
   */
  protected $entityBuffer;

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

  /**
   * 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('graphql.buffer.entity'));
  }

  /**
   * EntityById constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository service.
   * @param \Drupal\graphql\GraphQL\Buffers\EntityBuffer $entityBuffer
   *   The entity buffer service.
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, EntityTypeManagerInterface $entityTypeManager, EntityRepositoryInterface $entityRepository, EntityBuffer $entityBuffer) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->entityBuffer = $entityBuffer;
    $this->entityTypeManager = $entityTypeManager;
    $this->entityRepository = $entityRepository;
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    $resolver = $this->entityBuffer
      ->add($this
      ->getPluginDefinition()['entity_type'], $args['id']);
    return function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($resolver) {
      if (!($entity = $resolver())) {

        // If there is no entity with this id, add the list cache tags so that the
        // cache entry is purged whenever a new entity of this type is saved.
        $pluginDefinition = $this
          ->getPluginDefinition();
        $entityType = $this->entityTypeManager
          ->getDefinition($pluginDefinition['entity_type']);
        (yield (new CacheableValue(NULL))
          ->addCacheTags($entityType
          ->getListCacheTags()));
      }
      else {

        /** @var \Drupal\Core\Entity\EntityInterface $entity */
        $access = $entity
          ->access('view', NULL, TRUE);
        if ($access
          ->isAllowed()) {
          if (isset($args['language']) && $args['language'] != $entity
            ->language()
            ->getId() && $entity instanceof TranslatableInterface && $entity
            ->isTranslatable()) {
            if ($entity
              ->hasTranslation($args['language'])) {
              $entity = $entity
                ->getTranslation($args['language']);
            }
          }
          (yield $entity
            ->addCacheableDependency($access));
        }
        else {
          (yield new CacheableValue(NULL, [
            $access,
          ]));
        }
      }
    };
  }

}

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
EntityById::$entityBuffer protected property The entity buffer service.
EntityById::$entityRepository protected property The entity repository service.
EntityById::$entityTypeManager protected property The entity type manager service.
EntityById::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityById::resolveValues protected function Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
EntityById::__construct public function EntityById constructor. Overrides PluginBase::__construct
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.
TypedPluginTrait::buildType protected function