yaffs.net Git - yaffs-website/blob - web/modules/contrib/entity_browser/src/Annotation/EntityBrowserSelectionDisplay.php

   1 <?php
   2
   3 namespace Drupal\entity_browser\Annotation;
   4
   5 use Drupal\Component\Annotation\Plugin;
   6
   7 /**
   8  * Defines an entity browser selection display annotation object.
   9  *
  10  * @see hook_entity_browser_selection_display_info_alter()
  11  *
  12  * @Annotation
  13  */
  14 class EntityBrowserSelectionDisplay extends Plugin {
  15
  16   /**
  17    * The plugin ID.
  18    *
  19    * @var string
  20    */
  21   public $id;
  22
  23   /**
  24    * The human-readable name of the selection display.
  25    *
  26    * @ingroup plugin_translatable
  27    *
  28    * @var \Drupal\Core\Annotation\Translation
  29    */
  30   public $label;
  31
  32   /**
  33    * A brief description of the selection display.
  34    *
  35    * This will be shown when adding or configuring this selection display.
  36    *
  37    * @ingroup plugin_translatable
  38    *
  39    * @var \Drupal\Core\Annotation\Translation (optional)
  40    */
  41   public $description = '';
  42
  43   /**
  44    * Preselection support.
  45    *
  46    * This will be used by entity browser form element to check, if selection
  47    * display accepts preselection of entities.
  48    *
  49    * @var bool
  50    */
  51   public $acceptPreselection = FALSE;
  52
  53   /**
  54    * Indicates that javascript commands can be executed for Selection display.
  55    *
  56    * Currently supported javascript commands are adding and removing selection
  57    * from selection display. Javascript commands use Ajax requests to load
  58    * relevant changes and makes user experience way better, becase form is not
  59    * flashed every time.
  60    *
  61    * @var bool
  62    */
  63   public $js_commands = FALSE;
  64
  65 }