annotate core/modules/image/src/Annotation/ImageEffect.php @ 19:fa3358dc1485 tip

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