class ImageEffect

Same name in other branches
  1. 9 core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
  2. 10 core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
  3. 10 core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
  4. 11.x core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
  5. 11.x core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect

Defines an image effect annotation object.

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\Annotation\ImageToolkitOperation

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
10 classes are annotated with ImageEffect
AjaxTestImageEffect in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/AjaxTestImageEffect.php
Provides a test effect using Ajax in the configuration form.
ConvertImageEffect in core/modules/image/src/Plugin/ImageEffect/ConvertImageEffect.php
Converts an image resource.
CropImageEffect in core/modules/image/src/Plugin/ImageEffect/CropImageEffect.php
Crops an image resource.
DesaturateImageEffect in core/modules/image/src/Plugin/ImageEffect/DesaturateImageEffect.php
Desaturates (grayscale) an image resource.
NullTestImageEffect in core/modules/image/tests/modules/image_module_test/src/Plugin/ImageEffect/NullTestImageEffect.php
Performs no operation on an image resource.

... See full list

File

core/modules/image/src/Annotation/ImageEffect.php, line 26

Namespace

Drupal\image\Annotation
View source 
class ImageEffect extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The human-readable name of the image effect.
     *
     * @ingroup plugin_translatable
     *
     * @var \Drupal\Core\Annotation\Translation
     */
    public $label;
    
    /**
     * A brief description of the image effect.
     *
     * This will be shown when adding or configuring this image effect.
     *
     * @ingroup plugin_translatable
     *
     * @var \Drupal\Core\Annotation\Translation (optional)
     */
    public $description = '';

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ImageEffect::$description public property A brief description of the image effect.
ImageEffect::$id public property The plugin ID.
ImageEffect::$label public property The human-readable name of the image effect.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.