class EntityBrowserSelectionDisplay in Entity Browser 8

Defines an entity browser selection display annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entity_browser\Annotation\EntityBrowserSelectionDisplay

See also

hook_entity_browser_selection_display_info_alter()

3 classes are annotated with EntityBrowserSelectionDisplay

MultiStepDisplay in src/Plugin/EntityBrowser/SelectionDisplay/MultiStepDisplay.php

Show current selection and delivers selected entities.

NoDisplay in src/Plugin/EntityBrowser/SelectionDisplay/NoDisplay.php

Does not show current selection and immediately delivers selected entities.

View in src/Plugin/EntityBrowser/SelectionDisplay/View.php

Displays current selection in a View.

File

src/Annotation/EntityBrowserSelectionDisplay.php, line 14

Namespace

Drupal\entity_browser\Annotation

class EntityBrowserSelectionDisplay extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the selection display.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * A brief description of the selection display.
   *
   * This will be shown when adding or configuring this selection display.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

  /**
   * Preselection support.
   *
   * This will be used by entity browser form element to check, if selection
   * display accepts preselection of entities.
   *
   * @var bool
   */
  public $acceptPreselection = FALSE;

  /**
   * Indicates that javascript commands can be executed for Selection display.
   *
   * Currently supported javascript commands are adding and removing selection
   * from selection display. Javascript commands use Ajax requests to load
   * relevant changes and makes user experience way better, becase form is not
   * flashed every time.
   *
   * @var bool
   */
  public $js_commands = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
EntityBrowserSelectionDisplay::$acceptPreselection	public	property	Preselection support.
EntityBrowserSelectionDisplay::$description	public	property	A brief description of the selection display.
EntityBrowserSelectionDisplay::$id	public	property	The plugin ID.
EntityBrowserSelectionDisplay::$js_commands	public	property	Indicates that javascript commands can be executed for Selection display.
EntityBrowserSelectionDisplay::$label	public	property	The human-readable name of the selection display.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2