You are here

Home » API reference » GraphQL 8.3 » EntityReferenceQuery.php

class EntityReferenceQuery in GraphQL 8.3

Plugin annotation


@GraphQLField(
  id = "entity_reference_query",
  secure = true,
  type = "EntityQueryResult",
  arguments = {
    "filter" = "EntityQueryFilterInput",
    "sort" = "[EntityQuerySortInput]",
    "offset" = {
      "type" = "Int",
      "default" = 0
    },
    "limit" = {
      "type" = "Int",
      "default" = 10
    },
    "revisions" = {
      "type" = "EntityQueryRevisionMode",
      "default" = "default"
    }
  },
  deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityReferenceQueryDeriver"
)

Hierarchy

Expanded class hierarchy of EntityReferenceQuery

File

modules/graphql_core/src/Plugin/GraphQL/Fields/EntityReference/EntityReferenceQuery.php, line 34

Namespace

Drupal\graphql_core\Plugin\GraphQL\Fields\EntityReference
View source 
class EntityReferenceQuery extends EntityQuery {

  /**
   * {@inheritdoc}
   */
  public function getBaseQuery($value, array $args, ResolveContext $context, ResolveInfo $info) {
    if ($value instanceof ContentEntityInterface) {
      $query = parent::getBaseQuery($value, $args, $context, $info);
      $metadata = $query
        ->getMetadata('graphql_context');
      $ids = $metadata['ids'];
      if (empty($ids)) {
        return NULL;
      }
      $definition = $this
        ->getPluginDefinition();
      $key = $definition['entity_key'];
      $operator = is_array($ids) ? 'IN' : '=';
      $query
        ->condition($key, $ids, $operator);
      return $query;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getQueryContext($value, array $args, ResolveContext $context, ResolveInfo $info) {
    $context = parent::getQueryContext($value, $args, $context, $info);

    // Add the target field condition to the query.
    $definition = $this
      ->getPluginDefinition();
    $field = $definition['field'];
    $ids = array_map(function ($item) {
      return $item['target_id'];
    }, $value
      ->get($field)
      ->getValue());
    return [
      'ids' => $ids,
    ] + $context;
  }

}

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
EntityQuery::$entityTypeManager protected property The entity type manager.
EntityQuery::applyFilter protected function Apply the specified filter conditions to the query.
EntityQuery::applyRevisionsMode protected function Apply the specified revision filtering mode to the query.
EntityQuery::applySort protected function Apply the specified sort directives to the query.
EntityQuery::buildFilterConditions protected function Recursively builds the filter condition groups.
EntityQuery::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityQuery::getCacheDependencies protected function Retrieve the list of cache dependencies for a given value and arguments. Overrides FieldPluginBase::getCacheDependencies
EntityQuery::getEntityType protected function Retrieve the target entity type of this plugin.
EntityQuery::getQuery protected function Create the full entity query for the plugin's entity type.
EntityQuery::isNullOperator protected function Checks if an operator is a null operator.
EntityQuery::isRangeOperator protected function Checks if an operator is a range operator.
EntityQuery::isUnaryOperator protected function Checks if an operator is a unary operator.
EntityQuery::resolveValues public function Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
EntityQuery::__construct public function EntityQuery constructor. Overrides PluginBase::__construct
EntityReferenceQuery::getBaseQuery public function Create the basic entity query for the plugin's entity type. Overrides EntityQuery::getBaseQuery
EntityReferenceQuery::getQueryContext protected function Retrieves an arbitrary value to write into the query metadata. Overrides EntityQuery::getQueryContext
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::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