1. 8.2.x core/modules/image/src/Annotation/ImageEffect.php
  2. 8.0.x core/modules/image/src/Annotation/ImageEffect.php
  3. 8.1.x core/modules/image/src/Annotation/ImageEffect.php
  4. 8.3.x core/modules/image/src/Annotation/ImageEffect.php

Namespace

Drupal\image\Annotation

File

core/modules/image/src/Annotation/ImageEffect.php
View source
  1. <?php
  2. namespace Drupal\image\Annotation;
  3. use Drupal\Component\Annotation\Plugin;
  4. /**
  5. * Defines an image effect annotation object.
  6. *
  7. * Plugin Namespace: Plugin\ImageEffect
  8. *
  9. * For a working example, see
  10. * \Drupal\image\Plugin\ImageEffect\ResizeImageEffect
  11. *
  12. * @see hook_image_effect_info_alter()
  13. * @see \Drupal\image\ConfigurableImageEffectInterface
  14. * @see \Drupal\image\ConfigurableImageEffectBase
  15. * @see \Drupal\image\ImageEffectInterface
  16. * @see \Drupal\image\ImageEffectBase
  17. * @see \Drupal\image\ImageEffectManager
  18. * @see \Drupal\Core\ImageToolkit\Annotation\ImageToolkitOperation
  19. * @see plugin_api
  20. *
  21. * @Annotation
  22. */
  23. class ImageEffect extends Plugin {
  24. /**
  25. * The plugin ID.
  26. *
  27. * @var string
  28. */
  29. public $id;
  30. /**
  31. * The human-readable name of the image effect.
  32. *
  33. * @ingroup plugin_translatable
  34. *
  35. * @var \Drupal\Core\Annotation\Translation
  36. */
  37. public $label;
  38. /**
  39. * A brief description of the image effect.
  40. *
  41. * This will be shown when adding or configuring this image effect.
  42. *
  43. * @ingroup plugin_translatable
  44. *
  45. * @var \Drupal\Core\Annotation\Translation (optional)
  46. */
  47. public $description = '';
  48. }

Classes

Namesort descending Description
ImageEffect Defines an image effect annotation object.