You are here

Home » API reference » International Phone 8 » PhoneInternationalElement.php

class PhoneInternationalElement in International Phone 8

Same name and namespace in other branches
  1. 8.2 src/Element/PhoneInternationalElement.php \Drupal\phone_international\Element\PhoneInternationalElement
  2. 3.x src/Element/PhoneInternationalElement.php \Drupal\phone_international\Element\PhoneInternationalElement

Provides a phone_international form.

Usage example:

By default field has geolocation enable.

$form['phone'] = [
  '#type' => 'phone_international',
  '#title' => $this
    ->t('International Phone'),
];

If you want default country you need to do this:

$form['phone'] = [
  '#type' => 'phone_international',
  '#title' => $this
    ->t('International Phone'),
  '#attributes' => [
    'data-country' => 'PT',
    'data-geo' => 0,
  ],
];

Plugin annotation

@FormElement("phone_international");

Hierarchy

Expanded class hierarchy of PhoneInternationalElement

File

src/Element/PhoneInternationalElement.php, line 39

Namespace

Drupal\phone_international\Element
View source 
class PhoneInternationalElement extends FormElement {

  /**
   * Form element validation handler for #type 'color'.
   */
  public static function validateNumber(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $form_state
      ->setValueForElement($element, $value);
    if ($value !== '' && !Drupal::service('phone_international.validate')
      ->isValidNumber($value)) {
      $form_state
        ->setError($element, t('The %name "%phone_international" is not valid.', [
        '%phone_international' => $value,
        '%name' => $element['#title'],
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function preRenderInternationalPhone($element) {
    $element['#attributes']['type'] = 'tel';
    $element['#attributes']['class'][] = 'phone_international-number';
    $element['#attached']['library'][] = 'phone_international/phone_international';

    // Add auto geolocation.
    if (!array_key_exists('data-geo', $element['#attributes'])) {
      $element['#attributes']['data-geo'] = 1;
    }

    // Add default country.
    if (!array_key_exists('data-country', $element['#attributes'])) {
      $element['#attributes']['data-country'] = 'PT';
    }

    // Get Module path to load utilsTellInput.js.
    $module_handler = Drupal::service('module_handler');
    $module_path = $module_handler
      ->getModule('phone_international')
      ->getPath();
    $element['#attached']['drupalSettings']['phone_international']['path'] = $module_path;
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
      'disabled',
      'pattern',
    ]);
    static::setAttributes($element, [
      'form-tel',
    ]);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#size' => 30,
      '#maxlength' => 128,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateNumber',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderInternationalPhone',
        ],
      ],
      '#theme' => 'input__tel',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

}

Members

Namesort descending 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.
PhoneInternationalElement::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
PhoneInternationalElement::preRenderInternationalPhone public static function
PhoneInternationalElement::validateNumber public static function Form element validation handler for #type 'color'.
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.