class OptionsShsChosenWidget in Simple hierarchical select 8

Same name and namespace in other branches

2.0.x modules/shs_chosen/src/Plugin/Field/FieldWidget/OptionsShsChosenWidget.php \Drupal\shs_chosen\Plugin\Field\FieldWidget\OptionsShsChosenWidget

Plugin implementation of the 'options_shs_chosen' widget.

Plugin annotation


@FieldWidget(
  id = "options_shs_chosen",
  label = @Translation("Simple hierarchical select: Chosen"),
  field_types = {
    "entity_reference"
  },
  multiple_values = TRUE
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\Core\Field\Plugin\Field\FieldWidget\OptionsWidgetBase
    class \Drupal\Core\Field\Plugin\Field\FieldWidget\OptionsSelectWidget
    class \Drupal\shs\Plugin\Field\FieldWidget\OptionsShsWidget implements ContainerFactoryPluginInterface
    class \Drupal\shs_chosen\Plugin\Field\FieldWidget\OptionsShsChosenWidget

Expanded class hierarchy of OptionsShsChosenWidget

File

modules/shs_chosen/src/Plugin/Field/FieldWidget/OptionsShsChosenWidget.php, line 22

Namespace

Drupal\shs_chosen\Plugin\Field\FieldWidget

View source

class OptionsShsChosenWidget extends OptionsShsWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings_default = [
      'chosen_override' => FALSE,
      'chosen_settings' => [
        'disable_search' => FALSE,
        'search_contains' => FALSE,
        'placeholder_text_multiple' => t('Choose some options'),
        'placeholder_text_single' => t('Choose an option'),
        'no_results_text' => t('No results match'),
      ],
    ];
    return $settings_default + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $element = parent::settingsForm($form, $form_state);

    // Add custom settings.
    $element['chosen_override'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Custom chosen settings'),
      '#default_value' => $this
        ->getSetting('chosen_override'),
      '#description' => $this
        ->t('Override <a href=":url">global settings</a> made for chosen.', [
        ':url' => Url::fromRoute('chosen.admin')
          ->toString(),
      ]),
    ];
    $chosen_settings = $this
      ->getSetting('chosen_settings');
    $element['chosen_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Chosen overrides'),
      '#open' => TRUE,
      '#states' => [
        'invisible' => [
          'input[name="fields[' . $field_name . '][settings_edit_form][settings][chosen_override]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $element['chosen_settings']['disable_search'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Disable search box'),
      '#default_value' => $chosen_settings['disable_search'],
    ];
    $element['chosen_settings']['search_contains'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Search also in the middle of words'),
      '#default_value' => $chosen_settings['search_contains'],
    ];
    $element['chosen_settings']['placeholder_text_multiple'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder text of multiple selects'),
      '#default_value' => $chosen_settings['placeholder_text_multiple'],
    ];
    $element['chosen_settings']['placeholder_text_single'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder text of single selects'),
      '#default_value' => $chosen_settings['placeholder_text_single'],
    ];
    $element['chosen_settings']['no_results_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('No results text'),
      '#default_value' => $chosen_settings['no_results_text'],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    if ($this
      ->getSetting('chosen_override')) {
      $summary[] = $this
        ->t('Override chosen settings');
    }
    else {
      $summary[] = $this
        ->t('Use <a href=":url">global chosen settings</a>', [
        ':url' => Url::fromRoute('chosen.admin')
          ->toString(),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $element['#attached']['library'][] = 'shs_chosen/shs_chosen.form';
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
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.
OptionsSelectWidget::getEmptyLabel	protected	function	Returns the empty option label to add to the list of options, if any. Overrides OptionsWidgetBase::getEmptyLabel
OptionsSelectWidget::sanitizeLabel	protected	function	Sanitizes a string label to display as an option. Overrides OptionsWidgetBase::sanitizeLabel
OptionsShsChosenWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides OptionsShsWidget::defaultSettings
OptionsShsChosenWidget::formElement	public	function	Returns the form for a single field widget. Overrides OptionsShsWidget::formElement
OptionsShsChosenWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides OptionsShsWidget::settingsForm
OptionsShsChosenWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides OptionsShsWidget::settingsSummary
OptionsShsWidget::$widgetDefaults	protected	property	The widget defaults SHS service.
OptionsShsWidget::afterBuild	public static	function	After-build handler for field elements in a form. Overrides WidgetBase::afterBuild
OptionsShsWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
OptionsShsWidget::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
OptionsShsWidget::settingToString	protected	function	Return string representation of a setting.
OptionsShsWidget::supportsGroups	protected	function	Indicates whether the widgets support optgroups. Overrides OptionsSelectWidget::supportsGroups
OptionsShsWidget::validateElement	public static	function	Form validation handler for widget elements. Overrides OptionsWidgetBase::validateElement
OptionsShsWidget::__construct	public	function	Constructs a new OptionsShsWidget object. Overrides OptionsWidgetBase::__construct
OptionsWidgetBase::$column	protected	property	Abstract over the actual field columns, to allow different field types to reuse those widgets.
OptionsWidgetBase::getOptions	protected	function	Returns the array of options for the widget.
OptionsWidgetBase::getSelectedOptions	protected	function	Determines selected options from the incoming field values.
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.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class OptionsShsChosenWidget in Simple hierarchical select 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation