class ImageEffect
Same name and namespace in other branches
- 11.x core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
- 11.x core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
- 10 core/modules/image/src/Attribute/ImageEffect.php \Drupal\image\Attribute\ImageEffect
- 10 core/modules/image/src/Annotation/ImageEffect.php \Drupal\image\Annotation\ImageEffect
- 8.9.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
- class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\image\Annotation\ImageEffect extends \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of 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
Related topics
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.
File
-
core/
modules/ image/ src/ Annotation/ ImageEffect.php, line 26
Namespace
Drupal\image\AnnotationView 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 = '';
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.