class ImageDerivative in GraphQL 8.4
Returns an image style derivative of an image.
Plugin annotation
@DataProducer(
id = "image_derivative",
name = @Translation("Image Derivative"),
description = @Translation("Returns an image derivative."),
produces = @ContextDefinition("any",
label = @Translation("Image derivative properties")
),
consumes = {
"entity" = @ContextDefinition("entity",
label = @Translation("Entity"),
required = FALSE
),
"style" = @ContextDefinition("string",
label = @Translation("Image style")
)
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase implements DataProducerPluginInterface uses DataProducerPluginCachingTrait
- class \Drupal\graphql\Plugin\GraphQL\DataProducer\Entity\Fields\Image\ImageDerivative implements ContainerFactoryPluginInterface
- class \Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase implements DataProducerPluginInterface uses DataProducerPluginCachingTrait
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Expanded class hierarchy of ImageDerivative
File
- src/
Plugin/ GraphQL/ DataProducer/ Entity/ Fields/ Image/ ImageDerivative.php, line 35
Namespace
Drupal\graphql\Plugin\GraphQL\DataProducer\Entity\Fields\ImageView source
class ImageDerivative extends DataProducerPluginBase implements ContainerFactoryPluginInterface {
/**
* The rendering service.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* {@inheritdoc}
*
* @codeCoverageIgnore
*/
public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
return new static($configuration, $pluginId, $pluginDefinition, $container
->get('renderer'));
}
/**
* ImageDerivative constructor.
*
* @param array $configuration
* The plugin configuration array.
* @param string $pluginId
* The plugin id.
* @param mixed $pluginDefinition
* The plugin definition.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer service.
*
* @codeCoverageIgnore
*/
public function __construct(array $configuration, $pluginId, $pluginDefinition, RendererInterface $renderer) {
parent::__construct($configuration, $pluginId, $pluginDefinition);
$this->renderer = $renderer;
}
/**
* Resolver.
*
* @param \Drupal\file\FileInterface $entity
* @param string $style
* @param \Drupal\Core\Cache\RefinableCacheableDependencyInterface $metadata
*
* @return array|null
*/
public function resolve(FileInterface $entity = NULL, $style, RefinableCacheableDependencyInterface $metadata) {
// Return if we dont have an entity.
if (!$entity) {
return NULL;
}
$access = $entity
->access('view', NULL, TRUE);
$metadata
->addCacheableDependency($access);
if ($access
->isAllowed() && ($image_style = ImageStyle::load($style))) {
$width = $entity->width;
$height = $entity->height;
if (empty($width) || empty($height)) {
/** @var \Drupal\Core\Image\ImageInterface $image */
$image = \Drupal::service('image.factory')
->get($entity
->getFileUri());
if ($image
->isValid()) {
$width = $image
->getWidth();
$height = $image
->getHeight();
}
}
// Determine the dimensions of the styled image.
$dimensions = [
'width' => $width,
'height' => $height,
];
$image_style
->transformDimensions($dimensions, $entity
->getFileUri());
$metadata
->addCacheableDependency($image_style);
// The underlying URL generator that will be invoked will leak cache
// metadata, resulting in an exception. By wrapping within a new render
// context, we can capture the leaked metadata and make sure it gets
// incorporated into the response.
$context = new RenderContext();
$url = $this->renderer
->executeInRenderContext($context, function () use ($image_style, $entity) {
return $image_style
->buildUrl($entity
->getFileUri());
});
if (!$context
->isEmpty()) {
$metadata
->addCacheableDependency($context
->pop());
}
return [
'url' => $url,
'width' => $dimensions['width'],
'height' => $dimensions['height'],
];
}
return NULL;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextAwarePluginBase:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginBase:: |
private | property | Data objects representing the contexts passed in the plugin configuration. | |
ContextAwarePluginBase:: |
protected | function | Wraps the context handler. | |
ContextAwarePluginBase:: |
protected | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
9 |
ContextAwarePluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
7 |
ContextAwarePluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
4 |
ContextAwarePluginBase:: |
public | function |
This code is identical to the Component in order to pick up a different
Context class. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the value for a defined context. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Set a context on this plugin. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Sets the value for a defined context. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function | Implements magic __get() method. | |
DataProducerPluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
DataProducerPluginBase:: |
public | function |
Gets the context definitions of the plugin. Overrides ContextAwarePluginBase:: |
|
DataProducerPluginBase:: |
public | function |
Resolves the queried field with the given context. Overrides DataProducerPluginInterface:: |
|
DataProducerPluginCachingTrait:: |
public | function | ||
DataProducerPluginCachingTrait:: |
abstract public | function | ||
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
ImageDerivative:: |
protected | property | The rendering service. | |
ImageDerivative:: |
public static | function |
@codeCoverageIgnore Overrides ContainerFactoryPluginInterface:: |
|
ImageDerivative:: |
public | function | Resolver. | |
ImageDerivative:: |
public | function |
ImageDerivative constructor. Overrides ContextAwarePluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |