class TelephoneValidation in Telephone Validation 8.2

Provides element validation.

Usage example:

$form['phone'] = array(
  '#type' => 'tel',
  '#title' => t('Phone'),
  // Add #element_validate to your form element.
  '#element_validate' => [
    [
      'Drupal\\telephone_validation\\Render\\Element\\TelephoneValidation',
      'validateTel',
    ],
  ],
  // Customize validation settings. If not global settings will be in use.
  '#element_validate_settings' => [
    // By default input format should be consistent with E164 standard.
    'valid_format' => PhoneNumberFormat::E164,
    // By default all countries are valid.
    'valid_countries' => [],
  ],
);

Plugin annotation

@FormElement("tel");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Tel
          • class \Drupal\telephone_validation\Render\Element\TelephoneValidation

See also

\Drupal\Core\Render\Element\Tel

File

src/Render/Element/TelephoneValidation.php, line 32

Namespace

Drupal\telephone_validation\Render\Element

class TelephoneValidation extends Tel {

  /**
   * Form element validation handler.
   *
   * Note that #maxlength and #required is validated by _form_validate()
   * already.
   */
  public static function validateTel(&$element, FormStateInterface $form_state, &$complete_form) {

    // Get validation service.
    $service = \Drupal::service('telephone_validation.validator');

    // Normalize value.
    $value = $element['#value'];

    // Check if value is valid (if not empty).
    if ($value !== '' && !$service
      ->isValid($value, $element['#element_validate_settings']['format'], $element['#element_validate_settings']['country'])) {
      $form_state
        ->setError($element, t('The phone number %phone is not valid.', [
        '%phone' => $value,
      ]));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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.	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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.	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.
Tel::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
Tel::preRenderTel	public static	function	Prepares a #type 'tel' render element for input.html.twig.
TelephoneValidation::validateTel	public static	function	Form element validation handler.