class DropDown in Entity Browser 8

Displays widgets in a select list.

Plugin annotation

@EntityBrowserWidgetSelector(
  id = "drop_down",
  label = @Translation("Drop down widget"),
  description = @Translation("Displays the widgets in a drop down.")
)

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
      • class \Drupal\entity_browser\Plugin\EntityBrowser\WidgetSelector\DropDown

File

src/Plugin/EntityBrowser/WidgetSelector/DropDown.php, line 17

Namespace

Drupal\entity_browser\Plugin\EntityBrowser\WidgetSelector

class DropDown extends WidgetSelectorBase {

  /**
   * {@inheritdoc}
   */
  public function getForm(array &$form = [], FormStateInterface &$form_state = NULL) {

    // Set a wrapper container for us to replace the form on ajax call.
    $form['#prefix'] = '<div id="entity-browser-form">';
    $form['#suffix'] = '</div>';

    /** @var \Drupal\entity_browser\EntityBrowserInterface $browser */
    $browser = $form_state
      ->getFormObject()
      ->getEntityBrowser();
    $widget_ids = [];
    foreach ($this->widget_ids as $widget_id => $widget_name) {
      if ($browser
        ->getWidget($widget_id)
        ->access()
        ->isAllowed()) {
        $widget_ids[$widget_id] = $widget_name;
      }
    }
    $element['widget'] = [
      '#type' => 'select',
      '#options' => $widget_ids,
      '#default_value' => $this
        ->getDefaultWidget(),
      '#executes_submit_callback' => TRUE,
      '#limit_validation_errors' => [
        [
          'widget',
        ],
      ],
      // #limit_validation_errors only takes effect if #submit is present.
      '#submit' => [],
      '#ajax' => [
        'callback' => [
          $this,
          'changeWidgetCallback',
        ],
        'wrapper' => 'entity-browser-form',
      ],
    ];
    $element['change'] = [
      '#type' => 'submit',
      '#name' => 'change',
      '#value' => $this
        ->t('Change'),
      '#attributes' => [
        'class' => [
          'js-hide',
        ],
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$form, FormStateInterface $form_state) {
    return $form_state
      ->getValue('widget');
  }

  /**
   * AJAX callback to refresh form.
   *
   * @param array $form
   *   Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state object.
   *
   * @return array
   *   Form element to replace.
   */
  public function changeWidgetCallback(array &$form, FormStateInterface $form_state) {
    return $form;
  }

}

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
DropDown::changeWidgetCallback	public	function	AJAX callback to refresh form.
DropDown::getForm	public	function	Returns widget selector form. Overrides WidgetSelectorInterface::getForm
DropDown::submit	public	function	Submits form. Overrides WidgetSelectorBase::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::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::validate	public	function	Validates form. Overrides WidgetSelectorInterface::validate
WidgetSelectorBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct