class ImageDerivative in GraphQL 8.3

Retrieve the image field derivative (image style).

Plugin annotation

@GraphQLField(
  id = "image_derivative",
  secure = true,
  name = "derivative",
  type = "ImageResource",
  arguments = {
    "style" = "ImageStyleId!"
  },
  field_types = {"image"},
  provider = "image",
  deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityFieldPropertyDeriver"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase implements FieldPluginInterface uses ArgumentAwarePluginTrait, CacheablePluginTrait, DeprecatablePluginTrait, DescribablePluginTrait, TypedPluginTrait
    • class \Drupal\graphql_core\Plugin\GraphQL\Fields\Entity\Fields\Image\ImageDerivative implements ContainerFactoryPluginInterface uses DependencySerializationTrait

File

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/Fields/Image/ImageDerivative.php, line 33

Namespace

Drupal\graphql_core\Plugin\GraphQL\Fields\Entity\Fields\Image

class ImageDerivative extends FieldPluginBase implements ContainerFactoryPluginInterface {
  use DependencySerializationTrait;

  /**
   * The image factory.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

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

  /**
   * ImageDerivative constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition.
   * @param \Drupal\Core\Image\ImageFactory $imageFactory
   *   The image factory service.
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, ImageFactory $imageFactory) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->imageFactory = $imageFactory;
  }

  /**
   * {@inheritdoc}
   */
  protected function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    if ($value instanceof ImageItem && $value->entity && $value->entity
      ->access('view') && ($style = ImageStyle::load($args['style']))) {
      assert($style instanceof ImageStyle);
      $file = $value->entity;
      assert($file instanceof File);

      // Determine the dimensions of the styled image.
      $dimensions = [
        'width' => $value->width,
        'height' => $value->height,
      ];
      if ($style
        ->supportsUri($file
        ->getFileUri())) {
        $style
          ->transformDimensions($dimensions, $file
          ->getFileUri());
        $url = $style
          ->buildUrl($file
          ->getFileUri());
      }
      else {
        $url = $file
          ->url();
      }
      (yield new CacheableValue([
        'url' => $url,
        'width' => $dimensions['width'],
        'height' => $dimensions['height'],
      ], [
        $style,
      ]));
    }
  }

}

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
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
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.
ImageDerivative::$imageFactory	protected	property	The image factory.
ImageDerivative::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ImageDerivative::resolveValues	protected	function	Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
ImageDerivative::__construct	public	function	ImageDerivative constructor. Overrides PluginBase::__construct
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