class DummyWidget in Entity Browser 8

Dummy widget implementation for test purposes.

Plugin annotation

@EntityBrowserWidget(
  id = "dummy",
  label = @Translation("Dummy widget"),
  description = @Translation("Dummy widget existing for testing purposes."),
  auto_select = FALSE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_browser\WidgetBase implements ContainerFactoryPluginInterface, WidgetInterface uses PluginConfigurationFormTrait
      • class \Drupal\entity_browser_test\Plugin\EntityBrowser\Widget\DummyWidget

File

tests/modules/entity_browser_test/src/Plugin/EntityBrowser/Widget/DummyWidget.php, line 19

Namespace

Drupal\entity_browser_test\Plugin\EntityBrowser\Widget

class DummyWidget extends WidgetBase {

  /**
   * Entity to be returned.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  public $entity;

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'text' => '',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(array &$original_form, FormStateInterface $form_state, array $additional_widget_parameters) {
    return [
      '#markup' => $this->configuration['text'],
      '#parents' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$element, array &$form, FormStateInterface $form_state) {
    $this
      ->selectEntities([
      $this->entity,
    ], $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareEntities(array $form, FormStateInterface $form_state) {
    return $form_state
      ->getValue('dummy_entities', []);
  }

  /**
   * {@inheritdoc}
   */
  public function access() {
    if (\Drupal::state()
      ->get('eb_test_dummy_widget_access', TRUE)) {
      $access = AccessResult::allowed();
      $access
        ->addCacheContexts([
        'eb_dummy',
      ]);
    }
    else {
      $access = AccessResult::forbidden();
      $access
        ->addCacheContexts([
        'eb_dummy',
      ]);
    }
    return $access;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DummyWidget::$entity	public	property	Entity to be returned.
DummyWidget::access	public	function	Defines if the widget is visible / accessible in a given context. Overrides WidgetBase::access
DummyWidget::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides WidgetBase::defaultConfiguration
DummyWidget::getForm	public	function	Returns widget form. Overrides WidgetBase::getForm
DummyWidget::prepareEntities	protected	function	Prepares the entities without saving them. Overrides WidgetBase::prepareEntities
DummyWidget::submit	public	function	Submits form. Overrides WidgetBase::submit
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginConfigurationFormTrait::submitConfigurationForm	public	function	Implements PluginFormInterface::submitConfigurationForm().	3
PluginConfigurationFormTrait::validateConfigurationForm	public	function	Implements PluginFormInterface::validateConfigurationForm().	2
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WidgetBase::$entityTypeManager	protected	property	Entity type manager service.
WidgetBase::$eventDispatcher	protected	property	Event dispatcher service.
WidgetBase::$id	protected	property	Plugin id.
WidgetBase::$label	protected	property	Plugin label.
WidgetBase::$uuid	protected	property	Plugin uuid.
WidgetBase::$validationManager	protected	property	The Widget Validation Manager service.
WidgetBase::$weight	protected	property	Plugin weight.
WidgetBase::buildConfigurationForm	public	function	Implements PluginFormInterface::buildConfigurationForm(). Overrides PluginConfigurationFormTrait::buildConfigurationForm	3
WidgetBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
WidgetBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	3
WidgetBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetBase::getWeight	public	function	Returns the widget's weight. Overrides WidgetInterface::getWeight
WidgetBase::handleWidgetContext	protected	function	Allow configuration overrides at runtime based on widget context passed to this widget from the Entity Browser element.
WidgetBase::id	public	function	Returns the widget id. Overrides WidgetInterface::id
WidgetBase::label	public	function	Returns the widget label. Overrides WidgetInterface::label
WidgetBase::requiresJsCommands	public	function	Returns if widget requires JS commands support by selection display. Overrides WidgetInterface::requiresJsCommands
WidgetBase::runWidgetValidators	protected	function	Run widget validators.
WidgetBase::selectEntities	protected	function	Dispatches event that informs all subscribers about new selected entities.
WidgetBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetBase::setLabel	public	function	Sets the widget's label. Overrides WidgetInterface::setLabel
WidgetBase::setWeight	public	function	Sets the widget's weight. Overrides WidgetInterface::setWeight
WidgetBase::uuid	public	function	Returns the widget UUID. Overrides WidgetInterface::uuid
WidgetBase::validate	public	function	Validates form. Overrides WidgetInterface::validate	1
WidgetBase::__construct	public	function	WidgetBase constructor. Overrides PluginBase::__construct	3