You are here

Home » API reference » GraphQL 8.3 » Context.php

class Context in GraphQL 8.3

Request arbitrary drupal context objects with GraphQL.

Plugin annotation


@GraphQLField(
  id = "context",
  secure = true,
  parents = {"Root", "InternalUrl"},
  deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\ContextDeriver"
)

Hierarchy

Expanded class hierarchy of Context

File

modules/graphql_core/src/Plugin/GraphQL/Fields/Context/Context.php, line 24

Namespace

Drupal\graphql_core\Plugin\GraphQL\Fields\Context
View source 
class Context extends FieldPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The context repository service.
   *
   * @var \Drupal\Core\Plugin\Context\ContextRepositoryInterface
   */
  protected $contextRepository;

  /**
   * The subrequest buffer service.
   *
   * @var \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer
   */
  protected $subRequestBuffer;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
    return new static($configuration, $pluginId, $pluginDefinition, $container
      ->get('graphql.buffer.subrequest'), $container
      ->get('graphql.context_repository'));
  }

  /**
   * Context constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition.
   * @param \Drupal\graphql\GraphQL\Buffers\SubRequestBuffer $subRequestBuffer
   *   The sub-request buffer service.
   * @param \Drupal\Core\Plugin\Context\ContextRepositoryInterface $contextRepository
   *   The context repository service.
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, SubRequestBuffer $subRequestBuffer, ContextRepositoryInterface $contextRepository) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->contextRepository = $contextRepository;
    $this->subRequestBuffer = $subRequestBuffer;
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    if (!$value instanceof Url) {
      $value = Url::fromRoute('<front>');
    }
    $resolve = $this->subRequestBuffer
      ->add($value, function () {
      $id = $this
        ->getPluginDefinition()['context_id'];
      $contexts = $this->contextRepository
        ->getRuntimeContexts([
        $id,
      ]);
      return isset($contexts[$id]) ? $contexts[$id]
        ->getContextValue() : NULL;
    });
    return function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($resolve) {
      (yield $resolve());
    };
  }

}

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
Context::$contextRepository protected property The context repository service.
Context::$subRequestBuffer protected property The subrequest buffer service.
Context::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Context::resolveValues protected function Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
Context::__construct public function Context constructor. Overrides PluginBase::__construct
DeprecatablePluginTrait::buildDeprecationReason protected function
DescribablePluginTrait::buildDescription protected function
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