You are here

Home » API reference » YAML Form 8 » YamlFormEntityReferenceSelectWidget.php

class YamlFormEntityReferenceSelectWidget in YAML Form 8

Plugin implementation of the 'yamlform_entity_reference_select' widget.

Plugin annotation


@FieldWidget(
  id = "yamlform_entity_reference_select",
  label = @Translation("Select list"),
  description = @Translation("A select menu field."),
  field_types = {
    "yamlform"
  }
)

Hierarchy

Expanded class hierarchy of YamlFormEntityReferenceSelectWidget

See also

\Drupal\yamlform\Plugin\Field\FieldWidget\YamlFormEntityReferenceAutocompleteWidget

\Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget

\Drupal\Core\Field\Plugin\Field\FieldWidget\OptionsSelectWidget

File

src/Plugin/Field/FieldWidget/YamlFormEntityReferenceSelectWidget.php, line 25

Namespace

Drupal\yamlform\Plugin\Field\FieldWidget
View source 
class YamlFormEntityReferenceSelectWidget extends YamlFormEntityReferenceAutocompleteWidget {

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return [];
  }

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

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);

    // Convert 'entity_autocomplete' to 'yamlform_entity_select' element.
    $element['target_id']['#type'] = 'yamlform_entity_select';

    // Set empty option.
    if (empty($element['#required'])) {
      $element['target_id']['#empty_option'] = $this
        ->t('- Select -');
      $element['target_id']['#empty_value'] = '';
    }

    // Convert default_value's YamlForm to a simple entity_id.
    if (!empty($element['target_id']['#default_value']) && $element['target_id']['#default_value'] instanceof YamlFormInterface) {
      $element['target_id']['#default_value'] = $element['target_id']['#default_value']
        ->id();
    }

    // Remove properties that are not applicable.
    unset($element['target_id']['#size']);
    unset($element['target_id']['#maxlength']);
    unset($element['target_id']['#placeholder']);
    $element['#element_validate'] = [
      [
        get_class($this),
        'validateYamlFormEntityReferenceSelectWidget',
      ],
    ];
    return $element;
  }

  /**
   * Form element validation handler for entity_select elements.
   */
  public static function validateYamlFormEntityReferenceSelectWidget(array &$element, FormStateInterface $form_state, array &$complete_form) {

    // Below prevents the below error.
    // Fatal error: Call to a member function uuid() on a non-object in
    // core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php.
    $value = !empty($element['target_id']['#value']) ? $element['target_id']['#value'] : NULL;
    $form_state
      ->setValueForElement($element['target_id'], $value);
  }

}

Members

Namesort descending 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
EntityReferenceAutocompleteWidget::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
EntityReferenceAutocompleteWidget::getAutocreateBundle protected function Returns the name of the bundle which will be used for autocreated entities.
EntityReferenceAutocompleteWidget::getMatchOperatorOptions protected function Returns the options for the match operator.
EntityReferenceAutocompleteWidget::getSelectionHandlerSetting protected function Returns the value of a setting for the entity reference selection handler.
EntityReferenceAutocompleteWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues 1
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.
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::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
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::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5
YamlFormEntityReferenceSelectWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceAutocompleteWidget::defaultSettings
YamlFormEntityReferenceSelectWidget::formElement public function Returns the form for a single field widget. Overrides YamlFormEntityReferenceAutocompleteWidget::formElement
YamlFormEntityReferenceSelectWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides EntityReferenceAutocompleteWidget::settingsForm
YamlFormEntityReferenceSelectWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides EntityReferenceAutocompleteWidget::settingsSummary
YamlFormEntityReferenceSelectWidget::validateYamlFormEntityReferenceSelectWidget public static function Form element validation handler for entity_select elements.