You are here

Home » API reference » Webform 6.x » WebformEmailMultiple.php

class WebformEmailMultiple in Webform 6.x

Same name in this branch
  1. 6.x src/Element/WebformEmailMultiple.php \Drupal\webform\Element\WebformEmailMultiple
  2. 6.x src/Plugin/WebformElement/WebformEmailMultiple.php \Drupal\webform\Plugin\WebformElement\WebformEmailMultiple
Same name and namespace in other branches
  1. 8.5 src/Element/WebformEmailMultiple.php \Drupal\webform\Element\WebformEmailMultiple

Provides a webform element for entering multiple comma delimited email addresses.

Plugin annotation

@FormElement("webform_email_multiple");

Hierarchy

Expanded class hierarchy of WebformEmailMultiple

2 #type uses of WebformEmailMultiple
EmailWebformHandler::resendMessageForm in src/Plugin/WebformHandler/EmailWebformHandler.php
Build resend message webform.
WebformExampleCustomFormSettingsForm::buildForm in modules/webform_example_custom_form/src/Form/WebformExampleCustomFormSettingsForm.php
Form constructor.

File

src/Element/WebformEmailMultiple.php, line 14

Namespace

Drupal\webform\Element
View source 
class WebformEmailMultiple extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#description' => $this
        ->t('Multiple email addresses may be separated by commas.'),
      '#size' => 60,
      '#cardinality' => NULL,
      '#allow_tokens' => FALSE,
      '#process' => [
        [
          $class,
          'processWebformEmailConfirm',
        ],
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderWebformEmailMultiple',
        ],
      ],
      '#theme' => 'input__webform_email_multiple',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Process email multiple element.
   */
  public static function processWebformEmailConfirm(&$element, FormStateInterface $form_state, &$complete_form) {

    // Add validate callback.
    $element += [
      '#element_validate' => [],
    ];
    array_unshift($element['#element_validate'], [
      get_called_class(),
      'validateWebformEmailMultiple',
    ]);
    return $element;
  }

  /**
   * Webform element validation handler for #type 'webform_email_multiple'.
   */
  public static function validateWebformEmailMultiple(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $element['#value'] = $value;
    $form_state
      ->setValueForElement($element, $value);
    if ($value) {
      $values = preg_split('/\\s*,\\s*/', $value);

      // Validate email.
      foreach ($values as $value) {

        // Allow tokens to be included in multiple email list by skipping
        // validation if a token is present.
        if (!empty($element['#allow_tokens'] && preg_match('/\\[.+\\]/', $value))) {
          continue;
        }
        if (!\Drupal::service('email.validator')
          ->isValid($value)) {
          $form_state
            ->setError($element, t('The email address %mail is not valid.', [
            '%mail' => $value,
          ]));
          return;
        }
      }

      // Validate cardinality.
      if ($element['#cardinality'] && count($values) > $element['#cardinality']) {
        if (isset($element['#cardinality_error'])) {
          $form_state
            ->setError($element, $element['#cardinality_error']);
        }
        elseif (isset($element['#title'])) {
          $t_args = [
            '%name' => empty($element['#title']) ? $element['#parents'][0] : $element['#title'],
            '@count' => $element['#cardinality'],
          ];
          $error_message = \Drupal::translation()
            ->formatPlural($element['#cardinality'], '%name: this element cannot hold more than @count value.', '%name: this element cannot hold more than @count values.', $t_args);
          $form_state
            ->setError($element, $error_message);
        }
        else {
          $form_state
            ->setError($element);
        }
      }
    }
  }

  /**
   * Prepares a #type 'webform_email_multiple' render element for theme_element().
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for theme_element().
   */
  public static function preRenderWebformEmailMultiple(array $element) {
    $element['#attributes']['type'] = 'text';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-text',
      'webform-email-multiple',
    ]);
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 98
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
WebformEmailMultiple::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformEmailMultiple::preRenderWebformEmailMultiple public static function Prepares a #type 'webform_email_multiple' render element for theme_element().
WebformEmailMultiple::processWebformEmailConfirm public static function Process email multiple element.
WebformEmailMultiple::validateWebformEmailMultiple public static function Webform element validation handler for #type 'webform_email_multiple'.