Defines an image effect annotation object.
Plugin Namespace: Plugin\ImageEffect
For a working example, see \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\image\Annotation\ImageEffect
See also
hook_image_effect_info_alter()
\Drupal\image\ConfigurableImageEffectInterface
\Drupal\image\ConfigurableImageEffectBase
\Drupal\image\ImageEffectInterface
\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
Members
Name | Modifiers | Type | Description |
---|---|---|---|
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. |
Plugin::get | public | function | Gets the value of an annotation. Overrides AnnotationInterface::get |
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 |
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. |
Please login to continue.