You are here

Home » API reference » GraphQL 8.4 » TaxonomyLoadTree.php

class TaxonomyLoadTree in GraphQL 8.4

Loads the taxonomy tree.

Plugin annotation


@DataProducer(
  id = "taxonomy_load_tree",
  name = @Translation("Load multiple taxonomy terms"),
  description = @Translation("Loads Taxonomy terms as a tree"),
  produces = @ContextDefinition("taxonomy tree",
    label = @Translation("Taxonomy tree")
  ),
  consumes = {
    "vid" = @ContextDefinition("string",
      label = @Translation("Vocabulary id")
    ),
    "parent" = @ContextDefinition("integer",
      label = @Translation("The term ID under which to generate the tree"),
      required = FALSE
    ),
    "max_depth" = @ContextDefinition("integer",
      label = @Translation("Maximum tree depth"),
      required = FALSE
    ),
    "language" = @ContextDefinition("string",
      label = @Translation("Language"),
      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

Expanded class hierarchy of TaxonomyLoadTree

File

src/Plugin/GraphQL/DataProducer/Taxonomy/TaxonomyLoadTree.php, line 61

Namespace

Drupal\graphql\Plugin\GraphQL\DataProducer\Taxonomy
View source 
class TaxonomyLoadTree extends DataProducerPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The default max depth to search in taxonomy tree if it is not set.
   */
  const MAX_DEPTH = 10;

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

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

  /**
   * Resolves the taxonomy tree for given vocabulary.
   *
   * @param string $vid
   *   The vocanulary ID.
   * @param int $parent
   *   The ID of the parent's term to load the tree for.
   * @param int|null $max_depth
   *   Max depth to search in.
   * @param string|null $language
   *   Optional. Language to be respected for retrieved entities.
   * @param bool $access
   *   Whether check for access or not. Default is true.
   * @param \Drupal\Core\Session\AccountInterface|null $accessUser
   *   User entity to check access for. Default is null.
   * @param string $accessOperation
   *   Operation to check access for. Default is view.
   * @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
   *   The caching context related to the current field.
   *
   * @return \GraphQL\Deferred|null
   *   A promise that will return entities or NULL if there aren't any.
   */
  public function resolve(string $vid, int $parent, ?int $max_depth, ?string $language, bool $access, ?AccountInterface $accessUser, string $accessOperation, FieldContext $context) : ?Deferred {
    if (!isset($max_depth)) {
      $max_depth = self::MAX_DEPTH;
    }
    $terms = $this->entityTypeManager
      ->getStorage('taxonomy_term')
      ->loadTree($vid, $parent, $max_depth);
    $term_ids = array_column($terms, 'tid');
    $resolver = $this->entityBuffer
      ->add('taxonomy_term', $term_ids);
    return new Deferred(function () use ($language, $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('taxonomy_term');

        /** @var \Drupal\Core\Entity\EntityTypeInterface $type */
        $tags = $type
          ->getListCacheTags();
        $context
          ->addCacheTags($tags);
        return [];
      }
      foreach ($entities as $id => $entity) {
        $context
          ->addCacheableDependency($entities[$id]);
        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 = $entity
            ->access($accessOperation, $accessUser, TRUE);
          $context
            ->addCacheableDependency($accessResult);
          if (!$accessResult
            ->isAllowed()) {
            unset($entities[$id]);
            continue;
          }
        }
      }
      return $entities;
    });
  }

}

Members

Namesort descending 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
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.
TaxonomyLoadTree::$entityBuffer protected property The entity buffer service.
TaxonomyLoadTree::$entityTypeManager protected property The entity type manager service.
TaxonomyLoadTree::create public static function @codeCoverageIgnore Overrides ContainerFactoryPluginInterface::create
TaxonomyLoadTree::MAX_DEPTH constant The default max depth to search in taxonomy tree if it is not set.
TaxonomyLoadTree::resolve public function Resolves the taxonomy tree for given vocabulary.
TaxonomyLoadTree::__construct public function EntityLoad constructor. Overrides ContextAwarePluginBase::__construct
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