class PhoneInternationalElement in International Phone 3.x

Same name and namespace in other branches

8.2 src/Element/PhoneInternationalElement.php \Drupal\phone_international\Element\PhoneInternationalElement
8 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,
    // 0(Disable) or 1(Enable)
    'data-exclude' => [],
    'data-preferred' => [
      'PT',
    ],
  ],
];

Plugin annotation

@FormElement("phone_international");

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\phone_international\Element\PhoneInternationalElement

Expanded class hierarchy of PhoneInternationalElement

1 #type use of PhoneInternationalElement

PhoneInternationalDefaultWidget::formElement in src/Plugin/Field/FieldWidget/PhoneInternationalDefaultWidget.php: Returns the form for a single field widget.

File

src/Element/PhoneInternationalElement.php, line 39

Namespace

Drupal\phone_international\Element

View source

class PhoneInternationalElement extends FormElement {

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if (!empty($input['full_number'])) {
      return $input['full_number'];
    }
    else {
      return '';
    }
  }

  /**
   * Form element validation handler for #type 'phone_international'.
   */
  public static function validateNumber(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = $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 function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processInternationalPhone',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateNumber',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#tree' => TRUE,
      '#country' => '',
      '#geolocation' => 0,
      '#exclude' => [],
      '#preferred' => [],
    ];
  }

  /**
   * Add tel and hidden input to phone_international element.
   */
  public static function processInternationalPhone(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#attached']['library'][] = 'phone_international/phone_international';
    $element['int_phone'] = [
      '#type' => 'tel',
      '#default_value' => $element['#default_value'],
      '#attributes' => [
        'class' => [
          'phone_international-number',
        ],
        'data-country' => $element['#country'],
        'data-geo' => $element['#geolocation'],
        'data-exclude' => $element['#exclude_countries'] ? implode("-", $element['#exclude_countries']) : [],
        'data-preferred' => $element['#preferred_countries'] ? implode("-", $element['#preferred_countries']) : [],
      ],
      '#theme_wrappers' => [],
      '#size' => 30,
      '#maxlength' => 128,
    ];

    // Get library path to load utilsTellInput.js.
    $config = \Drupal::config('phone_international.settings');
    $cdn = $config
      ->get('cdn');
    if ($cdn) {
      $path = '//cdn.jsdelivr.net/npm/intl-tel-input/build';
    }
    else {
      $path = '/' . _phone_international_get_path();
    }
    $element['#attached']['drupalSettings']['phone_international']['path'] = $path;
    $element['full_number'] = [
      '#type' => 'hidden',
    ];
    if (isset($element['#value']) && !empty($element['#value'])) {
      $element['int_phone']['#value'] = $element['#value'];
      $element['full_number']['#value'] = $element['#value'];
    }
    if (isset($element['#default_value']) && !empty($element['#default_value'])) {
      $element['full_number']['#default_value'] = $element['#default_value'];
    }
    return $element;
  }

}

Members

Name	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.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PhoneInternationalElement::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
PhoneInternationalElement::processInternationalPhone	public static	function	Add tel and hidden input to phone_international element.
PhoneInternationalElement::validateNumber	public static	function	Form element validation handler for #type 'phone_international'.
PhoneInternationalElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
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.

You are here