aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/linkit/src/Annotation/Attribute.php

   1 <?php
   2
   3 /**
   4  * @file
   5  * Contains \Drupal\linkit\Annotation\Attribute.
   6  */
   7
   8 namespace Drupal\linkit\Annotation;
   9
  10 use Drupal\Component\Annotation\Plugin;
  11
  12 /**
  13  * Defines an attribute annotation object.
  14  *
  15  * Plugin Namespace: Plugin\Linkit\Attribute
  16  *
  17  * For a working example, see \Drupal\linkit\Plugin\Linkit\Attribute\Title
  18  *
  19  * @see \Drupal\linkit\AttributeInterface
  20  * @see \Drupal\linkit\AttributeBase
  21  * @see \Drupal\linkit\AttributeManager
  22  * @see plugin_api
  23  *
  24  * @Annotation
  25  */
  26 class Attribute 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 attribute.
  37    *
  38    * The string should be wrapped in a @Translation().
  39    *
  40    * @var \Drupal\Core\Annotation\Translation
  41    */
  42   public $label;
  43
  44   /**
  45    * The real HTML attribute name for this attribute.
  46    *
  47    * @var string
  48    */
  49   public $html_name;
  50
  51   /**
  52    * A brief description of the attribute.
  53    *
  54    * This will be shown when adding or configuring a profile.
  55    *
  56    * @ingroup plugin_translatable
  57    *
  58    * @var \Drupal\Core\Annotation\Translation (optional)
  59    */
  60   public $description = '';
  61
  62   /**
  63    * A default weight for the attribute.
  64    *
  65    * @var int (optional)
  66    */
  67   public $weight = 0;
  68
  69 }