WebformAutocomplete.php in Webform 8.5

Namespace

Drupal\webform\Plugin\WebformElement

File

src/Plugin/WebformElement/WebformAutocomplete.php

<?php

namespace Drupal\webform\Plugin\WebformElement;

use Drupal\Core\Form\FormStateInterface;
use Drupal\webform\WebformSubmissionInterface;

/**
 * Provides a 'autocomplete' element.
 *
 * @WebformElement(
 *   id = "webform_autocomplete",
 *   label = @Translation("Autocomplete"),
 *   description = @Translation("Provides a text field element with auto completion."),
 *   category = @Translation("Advanced elements"),
 * )
 */
class WebformAutocomplete extends TextField {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    $properties = [
      // Autocomplete settings.
      'autocomplete_existing' => FALSE,
      'autocomplete_items' => [],
      'autocomplete_limit' => 10,
      'autocomplete_match' => 3,
      'autocomplete_match_operator' => 'CONTAINS',
    ] + parent::defineDefaultProperties() + $this
      ->defineDefaultMultipleProperties();

    // Remove autocomplete property which is not applicable to
    // this autocomplete element.
    unset($properties['autocomplete']);
    return $properties;
  }

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    parent::prepare($element, $webform_submission);
    $has_items = !empty($element['#autocomplete_items']);

    // Query webform submission for existing items.
    if (!$has_items && !empty($element['#autocomplete_existing'])) {
      $has_items = \Drupal::database()
        ->select('webform_submission_data')
        ->fields('webform_submission_data', [
        'value',
      ])
        ->condition('webform_id', $webform_submission
        ->getWebform()
        ->id())
        ->condition('name', $element['#webform_key'])
        ->condition('value', '', '!=')
        ->execute()
        ->fetchField();
    }
    if ($has_items && isset($element['#webform_key'])) {
      $element['#autocomplete_route_name'] = 'webform.element.autocomplete';
      $element['#autocomplete_route_parameters'] = [
        'webform' => $webform_submission
          ->getWebform()
          ->id(),
        'key' => $element['#webform_key'],
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['autocomplete'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Autocomplete settings'),
    ];
    $form['autocomplete']['autocomplete_items'] = [
      '#type' => 'webform_element_options',
      '#custom__type' => 'webform_multiple',
      '#title' => $this
        ->t('Autocomplete values'),
    ];
    $form['autocomplete']['autocomplete_existing'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include existing submission values'),
      '#description' => $this
        ->t("If checked, all existing submission values will be visible to the webform's users."),
      '#return_value' => TRUE,
    ];
    $form['autocomplete']['autocomplete_limit'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Autocomplete limit'),
      '#description' => $this
        ->t("The maximum number of matches to be displayed."),
      '#min' => 1,
    ];
    $form['autocomplete']['autocomplete_match'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Autocomplete minimum number of characters'),
      '#description' => $this
        ->t('The minimum number of characters a user must type before a search is performed.'),
      '#min' => 1,
    ];
    $form['autocomplete']['autocomplete_match_operator'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Autocomplete matching operator'),
      '#description' => $this
        ->t('Select the method used to collect autocomplete suggestions.'),
      '#options' => [
        'STARTS_WITH' => $this
          ->t('Starts with'),
        'CONTAINS' => $this
          ->t('Contains'),
      ],
    ];
    return $form;
  }

}

Classes

Name	Description
WebformAutocomplete	Provides a 'autocomplete' element.