class ImageEffect

Same name in this branch
  1. 11.1.x core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect

Defines an ImageEffect attribute for plugin discovery.

Plugin Namespace: Plugin\ImageEffect

For a working example, see \Drupal\image\Plugin\ImageEffect\ResizeImageEffect

Hierarchy

Expanded class hierarchy of ImageEffect

See also

hook_image_effect_info_alter()

\Drupal\image\ConfigurableImageEffectInterface

\Drupal\image\ConfigurableImageEffectBase

\Drupal\image\ImageEffectInterface

\Drupal\image\ImageEffectBase

\Drupal\image\ImageEffectManager

\Drupal\Core\ImageToolkit\Attribute\ImageToolkitOperation

Plugin API

8 files declare their use of ImageEffect
ConvertImageEffect.php in core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php
CropImageEffect.php in core/modules/image/src/Plugin/ImageEffect/CropImageEffect.php
DesaturateImageEffect.php in core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php
ImageEffectManager.php in core/modules/image/src/ImageEffectManager.php
ResizeImageEffect.php in core/modules/image/src/Plugin/ImageEffect/ResizeImageEffect.php

... See full list

File

core/modules/image/src/Attribute/ImageEffect.php, line 27

Namespace

Drupal\image\Attribute
View source 
class ImageEffect extends Plugin {
    
    /**
     * Constructs an ImageEffect attribute.
     *
     * @param string $id
     *   The plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup $label
     *   The human-readable name of the image effect.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
     *   (optional) A brief description of the image effect. This will be shown
     *   when adding or configuring this image effect.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, TranslatableMarkup $label, ?TranslatableMarkup $description = NULL, ?string $deriver = NULL) {
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AttributeBase::$class protected property The class used for this attribute class.
AttributeBase::$provider protected property The provider of the attribute class.
AttributeBase::get public function Gets the value of an attribute. Overrides AttributeInterface::get 6
AttributeBase::getClass public function Gets the class of the attribute class. Overrides AttributeInterface::getClass 1
AttributeBase::getId public function Gets the unique ID for this attribute class. Overrides AttributeInterface::getId
AttributeBase::getProvider public function Gets the name of the provider of the attribute class. Overrides AttributeInterface::getProvider
AttributeBase::setClass public function Sets the class of the attributed class. Overrides AttributeInterface::setClass 1
AttributeBase::setProvider public function Sets the name of the provider of the attribute class. Overrides AttributeInterface::setProvider
ImageEffect::__construct public function Constructs an ImageEffect attribute. Overrides Plugin::__construct