class PhoneInternationalElement in International Phone 8.2
Same name and namespace in other branches
- 8 src/Element/PhoneInternationalElement.php \Drupal\phone_international\Element\PhoneInternationalElement
- 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
- 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
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of PhoneInternationalElement
File
- src/
Element/ PhoneInternationalElement.php, line 39
Namespace
Drupal\phone_international\ElementView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
FormElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementInterface:: |
15 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PhoneInternationalElement:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
PhoneInternationalElement:: |
public static | function | ||
PhoneInternationalElement:: |
public static | function | Form element validation handler for #type 'color'. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |