class WebformEntityReferenceAutocompleteWidget in Webform 6.x

Plugin implementation of the 'webform_entity_reference_autocomplete' widget.

Plugin annotation

@FieldWidget(
  id = "webform_entity_reference_autocomplete",
  label = @Translation("Autocomplete"),
  description = @Translation("An autocomplete text field."),
  field_types = {
    "webform"
  }
)

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
        • class \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget
          • class \Drupal\webform\Plugin\Field\FieldWidget\WebformEntityReferenceAutocompleteWidget uses WebformEntityReferenceWidgetTrait

File

src/Plugin/Field/FieldWidget/WebformEntityReferenceAutocompleteWidget.php, line 21

Namespace

Drupal\webform\Plugin\Field\FieldWidget

class WebformEntityReferenceAutocompleteWidget extends EntityReferenceAutocompleteWidget {
  use WebformEntityReferenceWidgetTrait;

  /**
   * {@inheritdoc}
   */
  public function getTargetIdElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {

    // Get default value.
    $referenced_entities = $items
      ->referencedEntities();
    $default_value = isset($referenced_entities[$delta]) ? $referenced_entities[$delta] : NULL;

    // Append the match operation to the selection settings.
    $selection_settings = $this
      ->getFieldSetting('handler_settings') + [
      'match_operator' => $this
        ->getSetting('match_operator'),
    ];
    return [
      '#type' => 'entity_autocomplete',
      '#target_type' => $this
        ->getFieldSetting('target_type'),
      '#selection_handler' => $this
        ->getFieldSetting('handler'),
      '#selection_settings' => $selection_settings,
      // Entity reference field items are handling validation themselves via
      // the 'ValidReference' constraint.
      '#validate_reference' => FALSE,
      '#maxlength' => 1024,
      '#default_value' => $default_value,
      '#size' => $this
        ->getSetting('size'),
      '#placeholder' => $this
        ->getSetting('placeholder'),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	4
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.
WebformAjaxElementTrait::buildAjaxElement	public	function	Build an Ajax element.
WebformAjaxElementTrait::buildAjaxElementTrigger	public	function	Build an Ajax element's trigger.
WebformAjaxElementTrait::buildAjaxElementUpdate	public	function	Build an Ajax element's update (submit) button.
WebformAjaxElementTrait::buildAjaxElementWrapper	public	function	Build an Ajax element's wrapper.
WebformAjaxElementTrait::getAjaxElementUpdateClass	public	function	Get Ajax element update class.
WebformAjaxElementTrait::getAjaxElementUpdateName	public	function	Get Ajax element update name.
WebformAjaxElementTrait::getAjaxElementWrapperId	public	function	Get Ajax element wrapper id.
WebformAjaxElementTrait::getAjaxElementWrapperRecursive	protected static	function	Get ajax element wrapper.
WebformAjaxElementTrait::submitAjaxElementCallback	public static	function	Ajax element submit callback.	2
WebformAjaxElementTrait::updateAjaxElementCallback	public static	function	Ajax element update callback.
WebformAjaxElementTrait::validateAjaxElementCallback	public static	function	Ajax element validate callback.
WebformEntityReferenceAutocompleteWidget::getTargetIdElement	public	function	Returns the target id element form for a single webform field widget. Overrides WebformEntityReferenceWidgetTrait::getTargetIdElement
WebformEntityReferenceWidgetTrait::$elementManager	protected	property	Webform element manager.
WebformEntityReferenceWidgetTrait::create	public static	function
WebformEntityReferenceWidgetTrait::defaultSettings	public static	function		1
WebformEntityReferenceWidgetTrait::formElement	public	function
WebformEntityReferenceWidgetTrait::massageFormValues	public	function
WebformEntityReferenceWidgetTrait::settingsForm	public	function
WebformEntityReferenceWidgetTrait::settingsSummary	public	function
WebformEntityReferenceWidgetTrait::validateOpenClose	public	function	Validate callback to ensure that the open date <= the close date.
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::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