class ImageEffect

Same name in this branch
  1. 10 core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
Same name in other branches
  1. 9 core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
  2. 8.9.x core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
  3. 11.x core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
  4. 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.

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 property is optional and it does not need to be declared.
     *
     * This will be shown when adding or configuring this image effect.
     *
     * @ingroup plugin_translatable
     *
     * @var \Drupal\Core\Annotation\Translation
     */
    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 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
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 1
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. 3

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