class EntityLoadMultiple in GraphQL 8.4

Load multiple entities by IDs.

Plugin annotation


@DataProducer(
  id = "entity_load_multiple",
  name = @Translation("Load multiple entities"),
  description = @Translation("Loads multiple entities."),
  produces = @ContextDefinition("entities",
    label = @Translation("Entities")
  ),
  consumes = {
    "type" = @ContextDefinition("string",
      label = @Translation("Entity type")
    ),
    "ids" = @ContextDefinition("string",
      label = @Translation("Identifier"),
      multiple = TRUE
    ),
    "language" = @ContextDefinition("string",
      label = @Translation("Entity language"),
      required = FALSE
    ),
    "bundles" = @ContextDefinition("string",
      label = @Translation("Entity bundle(s)"),
      multiple = TRUE,
      required = FALSE
    ),
    "access" = @ContextDefinition("boolean",
      label = @Translation("Check access"),
      required = FALSE,
      default_value = TRUE
    ),
    "access_user" = @ContextDefinition("entity:user",
      label = @Translation("User"),
      required = FALSE,
      default_value = NULL
    ),
    "access_operation" = @ContextDefinition("string",
      label = @Translation("Operation"),
      required = FALSE,
      default_value = "view"
    )
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase implements DataProducerPluginInterface uses DataProducerPluginCachingTrait
    class \Drupal\graphql\Plugin\GraphQL\DataProducer\Entity\EntityLoadMultiple implements ContainerFactoryPluginInterface

Expanded class hierarchy of EntityLoadMultiple

File

src/Plugin/GraphQL/DataProducer/Entity/EntityLoadMultiple.php, line 61

Namespace

Drupal\graphql\Plugin\GraphQL\DataProducer\Entity

View source

class EntityLoadMultiple extends DataProducerPluginBase implements ContainerFactoryPluginInterface {

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

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

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

  /**
   * {@inheritdoc}
   *
   * @codeCoverageIgnore
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('entity.repository'), $container
      ->get('graphql.buffer.entity'));
  }

  /**
   * EntityLoad constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param array $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\graphql\GraphQL\Buffers\EntityBuffer $entityBuffer
   *   The entity buffer service.
   *
   * @codeCoverageIgnore
   */
  public function __construct(array $configuration, $pluginId, array $pluginDefinition, EntityTypeManagerInterface $entityTypeManager, EntityRepositoryInterface $entityRepository, EntityBuffer $entityBuffer) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->entityTypeManager = $entityTypeManager;
    $this->entityRepository = $entityRepository;
    $this->entityBuffer = $entityBuffer;
  }

  /**
   * Resolver.
   *
   * @param string $type
   * @param array $ids
   * @param string|null $language
   * @param array|null $bundles
   * @param bool $access
   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
   * @param string|null $accessOperation
   * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
   *
   * @return \GraphQL\Deferred
   */
  public function resolve($type, array $ids, ?string $language, ?array $bundles, bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
    $resolver = $this->entityBuffer
      ->add($type, $ids);
    return new Deferred(function () use ($type, $language, $bundles, $resolver, $context, $access, $accessUser, $accessOperation) {

      /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
      $entities = $resolver();
      if (!$entities) {

        // 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.
        $type = $this->entityTypeManager
          ->getDefinition($type);

        /** @var \Drupal\Core\Entity\EntityTypeInterface $type */
        $tags = $type
          ->getListCacheTags();
        $context
          ->addCacheTags($tags);
        return [];
      }
      foreach ($entities as $id => $entity) {
        $context
          ->addCacheableDependency($entities[$id]);
        if (isset($bundles) && !in_array($entities[$id]
          ->bundle(), $bundles)) {

          // If the entity is not among the allowed bundles, don't return it.
          unset($entities[$id]);
          continue;
        }
        if (isset($language) && $language !== $entities[$id]
          ->language()
          ->getId() && $entities[$id] instanceof TranslatableInterface) {
          $entities[$id] = $entities[$id]
            ->getTranslation($language);
          $entities[$id]
            ->addCacheContexts([
            "static:language:{$language}",
          ]);
        }
        if ($access) {

          /** @var \Drupal\Core\Access\AccessResultInterface $accessResult */
          $accessResult = $entities[$id]
            ->access($accessOperation, $accessUser, TRUE);
          $context
            ->addCacheableDependency($accessResult);

          // We need to call isAllowed() because isForbidden() returns FALSE
          // for neutral access results, which is dangerous. Only an explicitly
          // allowed result means that the user has access.
          if (!$accessResult
            ->isAllowed()) {
            unset($entities[$id]);
            continue;
          }
        }
      }
      return $entities;
    });
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
DataProducerPluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
DataProducerPluginBase::getContextDefinitions	public	function	Gets the context definitions of the plugin. Overrides ContextAwarePluginBase::getContextDefinitions
DataProducerPluginBase::resolveField	public	function	Resolves the queried field with the given context. Overrides DataProducerPluginInterface::resolveField
DataProducerPluginCachingTrait::edgeCachePrefix	public	function
DataProducerPluginCachingTrait::getContextValues	abstract public	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
EntityLoadMultiple::$entityBuffer	protected	property	The entity buffer service.
EntityLoadMultiple::$entityRepository	protected	property	The entity repository service.
EntityLoadMultiple::$entityTypeManager	protected	property	The entity type manager service.
EntityLoadMultiple::create	public static	function	@codeCoverageIgnore Overrides ContainerFactoryPluginInterface::create
EntityLoadMultiple::resolve	public	function	Resolver.
EntityLoadMultiple::__construct	public	function	EntityLoad constructor. Overrides ContextAwarePluginBase::__construct
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class EntityLoadMultiple in GraphQL 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation