class EntitiesWithTerm in Thunder 6.2.x

The channel list producer class.

Plugin annotation

@DataProducer(
  id = "entities_with_term",
  name = @Translation("Term entity list"),
  description = @Translation("Loads a list of entities for a term."),
  produces = @ContextDefinition("any",
    label = @Translation("Term entity list")
  ),
  consumes = {
    "term" = @ContextDefinition("entity",
      label = @Translation("Term entity")
    ),
    "type" = @ContextDefinition("string",
      label = @Translation("Entity type")
    ),
    "bundles" = @ContextDefinition("any",
      label = @Translation("Entity bundles"),
      multiple = TRUE,
      required = FALSE,
      default_value = {}
    ),
    "field" = @ContextDefinition("any",
      label = @Translation("The term reference field"),
      multiple = FALSE,
      required = TRUE
    ),
    "offset" = @ContextDefinition("integer",
      label = @Translation("Offset"),
      required = FALSE,
      default_value = 0
    ),
    "limit" = @ContextDefinition("integer",
      label = @Translation("Limit"),
      required = FALSE,
      default_value = 100
    ),
    "languages" = @ContextDefinition("string",
      label = @Translation("Entity languages"),
      multiple = TRUE,
      required = FALSE,
      default_value = {}
    ),
    "sortBy" = @ContextDefinition("any",
      label = @Translation("Sorts"),
      multiple = TRUE,
      default_value = {},
      required = FALSE
    ),
    "depth" = @ContextDefinition("integer",
      label = @Translation("Depth"),
      required = FALSE,
      default_value = 0
    ),
  }
)

Hierarchy

• class \Drupal\thunder_gqls\Plugin\GraphQL\DataProducer\ThunderEntityListProducerBase extends \Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase implements ContainerFactoryPluginInterface
  • class \Drupal\thunder_gqls\Plugin\GraphQL\DataProducer\EntitiesWithTerm

File

modules/thunder_gqls/src/Plugin/GraphQL/DataProducer/EntitiesWithTerm.php, line 67

Namespace

Drupal\thunder_gqls\Plugin\GraphQL\DataProducer

class EntitiesWithTerm extends ThunderEntityListProducerBase {

  /**
   * Build entity query for entities, that reference a specific term.
   *
   * @param \Drupal\taxonomy\TermInterface $term
   *   The term entity interface.
   * @param string $type
   *   Entity type.
   * @param string[] $bundles
   *   List of bundles to be filtered.
   * @param string $field
   *   The term reference field of the bundle.
   * @param int $offset
   *   Query only entities owned by current user.
   * @param int $limit
   *   Maximum number of queried entities.
   * @param string[] $languages
   *   Languages for queried entities.
   * @param array $sortBy
   *   List of sorts.
   * @param int $depth
   *   The depth of children of the term.
   * @param \Drupal\graphql\GraphQL\Execution\FieldContext $cacheContext
   *   The caching context related to the current field.
   *
   * @return \Drupal\thunder_gqls\Wrappers\EntityListResponse
   *   Base entity list response.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function resolve(TermInterface $term, string $type, array $bundles, string $field, int $offset, int $limit, array $languages, array $sortBy, int $depth, FieldContext $cacheContext) : EntityListResponse {
    $termIds = [
      $term
        ->id(),
    ];
    if ($depth > 0) {
      $terms = $this->entityTypeManager
        ->getStorage('taxonomy_term')
        ->loadTree($term
        ->bundle(), $term
        ->id(), $depth);
      $termIds = array_merge($termIds, array_column($terms, 'tid'));
    }
    $conditions = [
      [
        'field' => $field,
        'value' => $termIds,
        'operator' => 'IN',
      ],
    ];
    $query = $this
      ->query($type, $bundles, $offset, $limit, $conditions, $languages, $sortBy, $cacheContext);
    return new EntityListResponse($query);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntitiesWithTerm::resolve	public	function	Build entity query for entities, that reference a specific term.
ThunderEntityListProducerBase::$currentUser	protected	property	The current user.
ThunderEntityListProducerBase::$entityTypeManager	protected	property	The entity type manager service.
ThunderEntityListProducerBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ThunderEntityListProducerBase::MAX_ITEMS		constant
ThunderEntityListProducerBase::query	protected	function	Build base entity query which may be reused for count query as well.
ThunderEntityListProducerBase::__construct	public	function	EntityLoad constructor.