class EntityReferenceAutocompleteWidget

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget

Plugin implementation of the 'entity_reference_autocomplete' widget.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of EntityReferenceAutocompleteWidget

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php, line 23

Namespace

Drupal\Core\Field\Plugin\Field\FieldWidget
View source
class EntityReferenceAutocompleteWidget extends WidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'match_operator' => 'CONTAINS',
            'match_limit' => 10,
            'size' => 60,
            'placeholder' => '',
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $element['match_operator'] = [
            '#type' => 'radios',
            '#title' => $this->t('Autocomplete matching'),
            '#default_value' => $this->getSetting('match_operator'),
            '#options' => $this->getMatchOperatorOptions(),
            '#description' => $this->t('Select the method used to collect autocomplete suggestions. Note that <em>Contains</em> can cause performance issues on sites with thousands of entities.'),
        ];
        $element['match_limit'] = [
            '#type' => 'number',
            '#title' => $this->t('Number of results'),
            '#default_value' => $this->getSetting('match_limit'),
            '#min' => 0,
            '#description' => $this->t('The number of suggestions that will be listed. Use <em>0</em> to remove the limit.'),
        ];
        $element['size'] = [
            '#type' => 'number',
            '#title' => $this->t('Size of textfield'),
            '#default_value' => $this->getSetting('size'),
            '#min' => 1,
            '#required' => TRUE,
        ];
        $element['placeholder'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Placeholder'),
            '#default_value' => $this->getSetting('placeholder'),
            '#description' => $this->t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
        ];
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = [];
        $operators = $this->getMatchOperatorOptions();
        $summary[] = $this->t('Autocomplete matching: @match_operator', [
            '@match_operator' => $operators[$this->getSetting('match_operator')],
        ]);
        $size = $this->getSetting('match_limit') ?: $this->t('unlimited');
        $summary[] = $this->t('Autocomplete suggestion list size: @size', [
            '@size' => $size,
        ]);
        $summary[] = $this->t('Textfield size: @size', [
            '@size' => $this->getSetting('size'),
        ]);
        $placeholder = $this->getSetting('placeholder');
        if (!empty($placeholder)) {
            $summary[] = $this->t('Placeholder: @placeholder', [
                '@placeholder' => $placeholder,
            ]);
        }
        else {
            $summary[] = $this->t('No placeholder');
        }
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $entity = $items->getEntity();
        $referenced_entities = $items->referencedEntities();
        // Append the match operation to the selection settings.
        $selection_settings = $this->getFieldSetting('handler_settings') + [
            'match_operator' => $this->getSetting('match_operator'),
            'match_limit' => $this->getSetting('match_limit'),
        ];
        $element += [
            '#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' => $referenced_entities[$delta] ?? NULL,
            '#size' => $this->getSetting('size'),
            '#placeholder' => $this->getSetting('placeholder'),
        ];
        if ($bundle = $this->getAutocreateBundle()) {
            $element['#autocreate'] = [
                'bundle' => $bundle,
                'uid' => $entity instanceof EntityOwnerInterface ? $entity->getOwnerId() : \Drupal::currentUser()->id(),
            ];
        }
        return [
            'target_id' => $element,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function errorElement(array $element, ConstraintViolationInterface $error, array $form, FormStateInterface $form_state) {
        return $element['target_id'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
        foreach ($values as $key => $value) {
            // The entity_autocomplete form element returns an array when an entity
            // was "autocreated", so we need to move it up a level.
            if (is_array($value['target_id'])) {
                unset($values[$key]['target_id']);
                $values[$key] += $value['target_id'];
            }
        }
        return $values;
    }
    
    /**
     * Returns the name of the bundle which will be used for autocreated entities.
     *
     * @return string
     *   The bundle name. If autocreate is not active, NULL will be returned.
     */
    protected function getAutocreateBundle() {
        $bundle = NULL;
        if ($this->getSelectionHandlerSetting('auto_create')) {
            $target_bundles = $this->getSelectionHandlerSetting('target_bundles');
            // If there's no target bundle at all, use the target_type. It's the
            // default for bundleless entity types.
            if (empty($target_bundles)) {
                $bundle = $this->getFieldSetting('target_type');
            }
            elseif (count($target_bundles) == 1) {
                $bundle = reset($target_bundles);
            }
            elseif (!($bundle = $this->getSelectionHandlerSetting('auto_create_bundle'))) {
                // If no bundle has been set as auto create target means that there is
                // an inconsistency in entity reference field settings.
                trigger_error(sprintf("The 'Create referenced entities if they don't already exist' option is enabled but a specific destination bundle is not set. You should re-visit and fix the settings of the '%s' (%s) field.", $this->fieldDefinition
                    ->getLabel(), $this->fieldDefinition
                    ->getName()), E_USER_WARNING);
            }
        }
        return $bundle;
    }
    
    /**
     * Returns the value of a setting for the entity reference selection handler.
     *
     * @param string $setting_name
     *   The setting name.
     *
     * @return mixed
     *   The setting value.
     */
    protected function getSelectionHandlerSetting($setting_name) {
        $settings = $this->getFieldSetting('handler_settings');
        return $settings[$setting_name] ?? NULL;
    }
    
    /**
     * Returns the options for the match operator.
     *
     * @return array
     *   List of options.
     */
    protected function getMatchOperatorOptions() {
        return [
            'STARTS_WITH' => $this->t('Starts with'),
            'CONTAINS' => $this->t('Contains'),
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
EntityReferenceAutocompleteWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceAutocompleteWidget::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
EntityReferenceAutocompleteWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement 1
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
EntityReferenceAutocompleteWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
EntityReferenceAutocompleteWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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
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 &quot;Add another item&quot; button.
WidgetBase::addMoreSubmit public static function Submission handler for the &quot;Add another item&quot; 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 3
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. 5

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.