You are here

class WebformTelephone in Webform 6.x

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

Provides a webform element for a telephone element.

Plugin annotation

@FormElement("webform_telephone");

Hierarchy

Expanded class hierarchy of WebformTelephone

File

src/Element/WebformTelephone.php, line 12

Namespace

Drupal\webform\Element
View source
class WebformTelephone extends WebformCompositeBase {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo() + [
      '#theme' => 'webform_composite_telephone',
    ];
    unset($info['#title_display']);
    return $info;
  }

  /**
   * {@inheritdoc}
   */
  public static function getCompositeElements(array $element) {
    $elements = [];
    $elements['type'] = [
      '#type' => 'select',
      '#title' => t('Type'),
      '#title_display' => 'invisible',
      '#options' => 'phone_types',
      '#empty_option' => t('- Type -'),
    ];
    $elements['phone'] = [
      '#type' => 'tel',
      '#title' => t('Phone'),
      '#title_display' => 'invisible',
      '#international' => TRUE,
    ];
    $elements['ext'] = [
      '#title' => t('Ext:'),
      '#type' => 'number',
      '#size' => 5,
      '#min' => 0,
    ];
    return $elements;
  }

  /**
   * Processes a composite webform element.
   */
  public static function processWebformComposite(&$element, FormStateInterface $form_state, &$complete_form) {
    $element = parent::processWebformComposite($element, $form_state, $complete_form);
    if (!empty($element['#phone__international']) && \Drupal::service('webform.libraries_manager')
      ->isIncluded('jquery.intl-tel-input')) {
      $element['#attached']['library'][] = 'webform/webform.telephone';
    }
    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.
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.
WebformCompositeBase::initializeCompositeElements public static function Initialize a composite's elements. Overrides WebformCompositeInterface::initializeCompositeElements
WebformCompositeBase::initializeCompositeElementsRecursive protected static function Initialize a composite's elements recursively.
WebformCompositeBase::preRenderCompositeFormElement public static function
WebformCompositeBase::processWebformCompositeElementsRecursive public static function Recursively processes a composite's elements.
WebformCompositeBase::validateWebformComposite public static function Validates a composite element.
WebformCompositeBase::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement public static function Adds form element theming to an element if its title or description is set. 1
WebformTelephone::getCompositeElements public static function Get a renderable array of webform elements. Overrides WebformCompositeBase::getCompositeElements
WebformTelephone::getInfo public function Returns the element properties for this element. Overrides WebformCompositeBase::getInfo
WebformTelephone::processWebformComposite public static function Processes a composite webform element. Overrides WebformCompositeBase::processWebformComposite