class EntityBrowserDisplay in Entity Browser 8

Defines an entity browser display annotation object.

Hierarchy

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

See also

hook_entity_browser_display_info_alter()

3 classes are annotated with EntityBrowserDisplay

IFrame in src/Plugin/EntityBrowser/Display/IFrame.php

Presents entity browser in an iFrame.

Modal in src/Plugin/EntityBrowser/Display/Modal.php

Presents entity browser in an Modal.

Standalone in src/Plugin/EntityBrowser/Display/Standalone.php

Presents entity browser as a standalone form.

File

src/Annotation/EntityBrowserDisplay.php, line 14

Namespace

Drupal\entity_browser\Annotation

class EntityBrowserDisplay extends Plugin {

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

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

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

  /**
   * Indicates that display uses route.
   *
   * @var string
   */
  public $uses_route = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
EntityBrowserDisplay::$description	public	property	A brief description of the display.
EntityBrowserDisplay::$id	public	property	The plugin ID.
EntityBrowserDisplay::$label	public	property	The human-readable name of the display.
EntityBrowserDisplay::$uses_route	public	property	Indicates that display uses route.
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