abstract class WidgetSelectorBase in Entity Browser 8

Base class for widget selector plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_browser\WidgetSelectorBase implements WidgetSelectorInterface uses PluginConfigurationFormTrait

3 files declare their use of WidgetSelectorBase

DropDown.php in src/Plugin/EntityBrowser/WidgetSelector/DropDown.php

Single.php in src/Plugin/EntityBrowser/WidgetSelector/Single.php

Tabs.php in src/Plugin/EntityBrowser/WidgetSelector/Tabs.php

File

src/WidgetSelectorBase.php, line 12

Namespace

Drupal\entity_browser

abstract class WidgetSelectorBase extends PluginBase implements WidgetSelectorInterface {
  use PluginConfigurationFormTrait;

  /**
   * Plugin label.
   *
   * @var string
   */
  protected $label;

  /**
   * Available widgets.
   *
   * @var array
   */
  protected $widgets_ids;

  /**
   * ID of the default widget.
   *
   * @var string
   */
  protected $defaultWidget;

  /**
   * {@inheritdoc}
   */
  public function __construct($configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this
      ->setConfiguration($configuration);
    $this->widget_ids = isset($this->configuration['widget_ids']) ? $this->configuration['widget_ids'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return array_diff_key($this->configuration, [
      'widget_ids' => 0,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this
      ->defaultConfiguration(), $configuration);
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return $this->label;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultWidget() {
    return $this->defaultWidget;
  }

  /**
   * {@inheritdoc}
   */
  public function setDefaultWidget($widget) {
    $this->defaultWidget = $widget;
  }

  /**
   * {@inheritdoc}
   */
  public function validate(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$form, FormStateInterface $form_state) {
  }

}

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
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::buildConfigurationForm	public	function	Implements PluginFormInterface::buildConfigurationForm().	5
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.
WidgetSelectorBase::$defaultWidget	protected	property	ID of the default widget.
WidgetSelectorBase::$label	protected	property	Plugin label.
WidgetSelectorBase::$widgets_ids	protected	property	Available widgets.
WidgetSelectorBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
WidgetSelectorBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
WidgetSelectorBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetSelectorBase::getDefaultWidget	protected	function
WidgetSelectorBase::label	public	function	Returns the widget selector label. Overrides WidgetSelectorInterface::label
WidgetSelectorBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetSelectorBase::setDefaultWidget	public	function	Sets the default widget. Overrides WidgetSelectorInterface::setDefaultWidget
WidgetSelectorBase::submit	public	function	Submits form. Overrides WidgetSelectorInterface::submit	2
WidgetSelectorBase::validate	public	function	Validates form. Overrides WidgetSelectorInterface::validate
WidgetSelectorBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
WidgetSelectorInterface::getForm	public	function	Returns widget selector form.	3