aleph1.co.uk Git - yaffs-website/blob - src/Annotation/ImageEffect.php

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