abstract class FieldPluginBase in GraphQL 8.3

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase implements FieldPluginInterface uses ArgumentAwarePluginTrait, CacheablePluginTrait, DeprecatablePluginTrait, DescribablePluginTrait, TypedPluginTrait

Expanded class hierarchy of FieldPluginBase

91 files declare their use of FieldPluginBase

Alias.php in modules/graphql_core/src/Plugin/GraphQL/Fields/Routing/InternalUrl/Alias.php
AvailableLanguages.php in modules/graphql_core/src/Plugin/GraphQL/Fields/Languages/AvailableLanguages.php
BackupCar.php in tests/modules/graphql_plugin_test/src/Plugin/GraphQL/Fields/BackupCar.php
BlocksByRegion.php in modules/graphql_core/src/Plugin/GraphQL/Fields/Blocks/BlocksByRegion.php
Breadcrumbs.php in modules/graphql_core/src/Plugin/GraphQL/Fields/Breadcrumbs/Breadcrumbs.php

... See full list

File

src/Plugin/GraphQL/Fields/FieldPluginBase.php, line 25

Namespace

Drupal\graphql\Plugin\GraphQL\Fields

View source

abstract class FieldPluginBase extends PluginBase implements FieldPluginInterface {
  use CacheablePluginTrait;
  use DescribablePluginTrait;
  use TypedPluginTrait;
  use ArgumentAwarePluginTrait;
  use DeprecatablePluginTrait;

  /**
   * The language context service.
   *
   * @var \Drupal\graphql\GraphQLLanguageContext
   */
  protected $languageContext;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Static cache for `isLanguageAwareField()`
   *
   * @var boolean
   */
  protected $isLanguageAware = NULL;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(SchemaBuilderInterface $builder, FieldPluginManager $manager, $definition, $id) {
    return [
      'description' => $definition['description'],
      'contexts' => $definition['contexts'],
      'deprecationReason' => $definition['deprecationReason'],
      'type' => $builder
        ->processType($definition['type']),
      'args' => $builder
        ->processArguments($definition['args']),
      'resolve' => function ($value, array $args, ResolveContext $context, ResolveInfo $info) use ($manager, $id) {
        $instance = $manager
          ->getInstance([
          'id' => $id,
        ]);
        return $instance
          ->resolve($value, $args, $context, $info);
      },
    ];
  }

  /**
   * Get the language context instance.
   *
   * @return \Drupal\graphql\GraphQLLanguageContext
   *   The language context service.
   */
  protected function getLanguageContext() {
    if (!isset($this->languageContext)) {
      $this->languageContext = \Drupal::service('graphql.language_context');
    }
    return $this->languageContext;
  }

  /**
   * Get the renderer service.
   *
   * @return \Drupal\Core\Render\RendererInterface
   */
  protected function getRenderer() {
    if (!isset($this->renderer)) {
      $this->renderer = \Drupal::service('renderer');
    }
    return $this->renderer;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinition() {
    $definition = $this
      ->getPluginDefinition();
    return [
      'type' => $this
        ->buildType($definition),
      'description' => $this
        ->buildDescription($definition),
      'args' => $this
        ->buildArguments($definition),
      'deprecationReason' => $this
        ->buildDeprecationReason($definition),
      'contexts' => $this
        ->buildCacheContexts($definition),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function resolve($value, array $args, ResolveContext $context, ResolveInfo $info) {
    $definition = $this
      ->getPluginDefinition();

    // If not resolving in a trusted environment, check if the field is secure.
    if (!$context
      ->getGlobal('development', FALSE) && !$context
      ->getGlobal('bypass field security', FALSE)) {
      if (empty($definition['secure'])) {
        throw new \Exception(sprintf("Unable to resolve insecure field '%s'.", $info->fieldName));
      }
    }
    foreach ($definition['contextual_arguments'] as $argument) {
      if (array_key_exists($argument, $args) && !is_null($args[$argument])) {
        $context
          ->setContext($argument, $args[$argument], $info);
      }
      $args[$argument] = $context
        ->getContext($argument, $info);
    }
    return $this
      ->resolveDeferred([
      $this,
      'resolveValues',
    ], $value, $args, $context, $info);
  }

  /**
   * Indicator if the field is language aware.
   *
   * Checks for 'languages:*' cache contexts on the fields definition.
   *
   * @return bool
   *   The fields language awareness status.
   */
  protected function isLanguageAwareField() {
    if (is_null($this->isLanguageAware)) {
      $this->isLanguageAware = (bool) count(array_filter($this
        ->getPluginDefinition()['response_cache_contexts'], function ($context) {
        return strpos($context, 'languages:') === 0;
      }));
    }
    return $this->isLanguageAware;
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveDeferred(callable $callback, $value, array $args, ResolveContext $context, ResolveInfo $info) {
    $isLanguageAware = $this
      ->isLanguageAwareField();
    $languageContext = $this
      ->getLanguageContext();
    $renderContext = new RenderContext();
    $executor = function () use ($callback, $renderContext, $value, $args, $context, $info) {
      return $this
        ->getRenderer()
        ->executeInRenderContext($renderContext, function () use ($callback, $value, $args, $context, $info) {
        $result = $callback($value, $args, $context, $info);
        if ($result instanceof \Generator) {
          $result = iterator_to_array($result);
        }
        return $result;
      });
    };
    $result = $isLanguageAware ? $languageContext
      ->executeInLanguageContext($executor, $context
      ->getContext('language', $info)) : $executor();
    if (!$renderContext
      ->isEmpty() && $info->operation->operation === 'query') {
      $context
        ->addCacheableDependency($renderContext
        ->pop());
    }
    if (is_callable($result)) {
      return new Deferred(function () use ($result, $value, $args, $context, $info, $isLanguageAware, $languageContext) {
        if ($isLanguageAware) {
          return $languageContext
            ->executeInLanguageContext(function () use ($result, $value, $args, $context, $info) {
            return $this
              ->resolveDeferred($result, $value, $args, $context, $info);
          }, $context
            ->getContext('language', $info));
        }
        return $this
          ->resolveDeferred($result, $value, $args, $context, $info);
      });
    }

    // Only collect cache metadata if this is a query. All other operation types
    // are not cacheable anyways.
    if ($info->operation->operation === 'query') {
      $dependencies = $this
        ->getCacheDependencies($result, $value, $args, $context, $info);
      foreach ($dependencies as $dependency) {
        $context
          ->addCacheableDependency($dependency);
      }
    }
    return $this
      ->unwrapResult($result, $info);
  }

  /**
   * Unwrap the resolved values.
   *
   * @param array $result
   *   The resolved values.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return mixed
   *   The extracted values (an array of values in case this is a list, an
   *   arbitrary value if it isn't).
   */
  protected function unwrapResult($result, ResolveInfo $info) {
    $result = array_map(function ($item) {
      return $item instanceof ValueWrapperInterface ? $item
        ->getValue() : $item;
    }, $result);
    $result = array_map(function ($item) {
      return $item instanceof MarkupInterface ? $item
        ->__toString() : $item;
    }, $result);

    // If this is a list, return the result as an array.
    $type = $info->returnType;
    if ($type instanceof ListOfType || $type instanceof NonNull && $type
      ->getWrappedType() instanceof ListOfType) {
      return $result;
    }
    return !empty($result) ? reset($result) : NULL;
  }

  /**
   * Retrieve the list of cache dependencies for a given value and arguments.
   *
   * @param array $result
   *   The result of the field.
   * @param mixed $parent
   *   The parent value.
   * @param array $args
   *   The arguments passed to the field.
   * @param \Drupal\graphql\GraphQL\Execution\ResolveContext $context
   *   The resolve context.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return array
   *   A list of cacheable dependencies.
   */
  protected function getCacheDependencies(array $result, $parent, array $args, ResolveContext $context, ResolveInfo $info) {
    $self = new CacheableMetadata();
    $definition = $this
      ->getPluginDefinition();
    if (!empty($definition['response_cache_contexts'])) {
      $self
        ->addCacheContexts($definition['response_cache_contexts']);
    }
    if (!empty($definition['response_cache_tags'])) {
      $self
        ->addCacheTags($definition['response_cache_tags']);
    }
    if (isset($definition['response_cache_max_age'])) {
      $self
        ->mergeCacheMaxAge($definition['response_cache_max_age']);
    }
    return array_merge([
      $self,
    ], array_filter($result, function ($item) {
      return $item instanceof CacheableDependencyInterface;
    }));
  }

  /**
   * Retrieve the list of field values.
   *
   * Always returns a list of field values. Even for single value fields.
   * Single/multi field handling is responsibility of the base class.
   *
   * @param mixed $value
   *   The current object value.
   * @param array $args
   *   Field arguments.
   * @param $context
   *   The resolve context.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return \Generator
   *   The value generator.
   */
  protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {

    // Allow overriding this class without having to declare this method.
    (yield NULL);
  }

}

Members

Name	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
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::resolveValues	protected	function	Retrieve the list of field values.	91
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
TypedPluginTrait::buildType	protected	function

You are here

abstract class FieldPluginBase in GraphQL 8.3

Hierarchy

File

Namespace

Members

API Navigation