class DropDown in Entity Browser 8.2
Same name and namespace in other branches
- 8 src/Plugin/EntityBrowser/WidgetSelector/DropDown.php \Drupal\entity_browser\Plugin\EntityBrowser\WidgetSelector\DropDown
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
- class \Drupal\entity_browser\WidgetSelectorBase implements WidgetSelectorInterface uses PluginConfigurationFormTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DropDown
File
- src/
Plugin/ EntityBrowser/ WidgetSelector/ DropDown.php, line 17
Namespace
Drupal\entity_browser\Plugin\EntityBrowser\WidgetSelectorView source
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:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DropDown:: |
public | function | AJAX callback to refresh form. | |
DropDown:: |
public | function |
Returns widget selector form. Overrides WidgetSelectorInterface:: |
|
DropDown:: |
public | function |
Submits form. Overrides WidgetSelectorBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginConfigurationFormTrait:: |
public | function | Implements PluginFormInterface::buildConfigurationForm(). | 5 |
PluginConfigurationFormTrait:: |
public | function | Implements PluginFormInterface::submitConfigurationForm(). | 3 |
PluginConfigurationFormTrait:: |
public | function | Implements PluginFormInterface::validateConfigurationForm(). | 2 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WidgetSelectorBase:: |
protected | property | ID of the default widget. | |
WidgetSelectorBase:: |
protected | property | Plugin label. | |
WidgetSelectorBase:: |
protected | property | Available widgets. | |
WidgetSelectorBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
WidgetSelectorBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
|
WidgetSelectorBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
WidgetSelectorBase:: |
protected | function | ||
WidgetSelectorBase:: |
public | function |
Returns the widget selector label. Overrides WidgetSelectorInterface:: |
|
WidgetSelectorBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
WidgetSelectorBase:: |
public | function |
Sets the default widget. Overrides WidgetSelectorInterface:: |
|
WidgetSelectorBase:: |
public | function |
Validates form. Overrides WidgetSelectorInterface:: |
|
WidgetSelectorBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |