www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/entity_embed/src/Annotation/EntityEmbedDisplay.php

   1 <?php
   2
   3 namespace Drupal\entity_embed\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines an Entity Embed Display plugin annotation object.
   9  *
  10  * Plugin Namespace: Plugin/entity_embed/EntityEmbedDisplay.
  11  *
  12  * For a working example, see \Drupal\entity_embed\Plugin\entity_embed\EntityEmbedDisplay\FileFieldFormatter
  13  *
  14  * @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayBase
  15  * @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface
  16  * @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager
  17  * @see plugin_api
  18  *
  19  * @ingroup entity_embed_api
  20  *
  21  * @Annotation
  22  */
  23 class EntityEmbedDisplay extends Plugin {
  24
  25   /**
  26    * The plugin ID.
  27    *
  28    * @var string
  29    */
  30   public $id;
  31
  32   /**
  33    * The human-readable name of the Entity Embed Display plugin.
  34    *
  35    * @ingroup plugin_translatable
  36    *
  37    * @var \Drupal\Core\Annotation\Translation
  38    */
  39   public $label = '';
  40
  41   /**
  42    * The entity types the Entity Embed Display plugin can apply to.
  43    *
  44    * To make the Entity Embed Display plugin valid for all entity types, set
  45    * this value to FALSE.
  46    *
  47    * @var bool|array
  48    */
  49   public $entity_types = FALSE;
  50
  51   /**
  52    * Shows plugin in the UI if this is FALSE.
  53    *
  54    * @var bool
  55    */
  56   public $no_ui = FALSE;
  57
  58 }