You are here

class EntityBrowserWidget in Entity Browser 8

Same name and namespace in other branches
  1. 8.2 src/Annotation/EntityBrowserWidget.php \Drupal\entity_browser\Annotation\EntityBrowserWidget

Defines an entity browser widget annotation object.

Hierarchy

Expanded class hierarchy of EntityBrowserWidget

See also

hook_entity_browser_widget_info_alter()

6 classes are annotated with EntityBrowserWidget
DummyWidget in tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/DummyWidget.php
Dummy widget implementation for test purposes.
EntityForm in modules/entity_form/src/Plugin/EntityBrowser/Widget/EntityForm.php
Provides entity form widget.
MultipleSubmitTestWidget in tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/MultipleSubmitTestWidget.php
Test widget with multiple submit buttons for test purposes.
PagerTestWidget in tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/PagerTestWidget.php
Pager test widget implementation for test purposes.
Upload in src/Plugin/EntityBrowser/Widget/Upload.php
Adds an upload field browser's widget.

... See full list

File

src/Annotation/EntityBrowserWidget.php, line 14

Namespace

Drupal\entity_browser\Annotation
View source
class EntityBrowserWidget extends Plugin {

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

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

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

  /**
   * Indicates that widget supports auto selection of entities.
   *
   * @var bool
   */
  public $auto_select = FALSE;

}

Members

Namesort descending Modifiers Type Description Overrides
EntityBrowserWidget::$auto_select public property Indicates that widget supports auto selection of entities.
EntityBrowserWidget::$description public property A brief description of the widget.
EntityBrowserWidget::$id public property The plugin ID.
EntityBrowserWidget::$label public property The human-readable name of the widget.
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