You are here

class WebformAddressLoqate in Loqate 2.x

Same name in this branch
  1. 2.x modules/pca_webform/src/Element/WebformAddressLoqate.php \Drupal\pca_webform\Element\WebformAddressLoqate
  2. 2.x modules/pca_webform/src/Plugin/WebformElement/WebformAddressLoqate.php \Drupal\pca_webform\Plugin\WebformElement\WebformAddressLoqate
Same name and namespace in other branches
  1. 8 modules/pca_webform/src/Element/WebformAddressLoqate.php \Drupal\pca_webform\Element\WebformAddressLoqate

Provides a Webform element for an address element.

Plugin annotation

@FormElement("webform_address_loqate");

Hierarchy

Expanded class hierarchy of WebformAddressLoqate

Deprecated

in Loqate 2.1.0 and will be removed in Loqate 3.0.0. Use \Drupal\loqate\Element\PcaAddress instead.

File

modules/pca_webform/src/Element/WebformAddressLoqate.php, line 16

Namespace

Drupal\pca_webform\Element
View source
class WebformAddressLoqate extends WebformCompositeBase {

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

  /**
   * {@inheritdoc}
   */
  public static function preRenderWebformCompositeFormElement($element) {
    $element = parent::preRenderWebformCompositeFormElement($element);

    // Address lookup wrapper & trigger class.
    $element['#attributes']['class'][] = 'address-lookup';
    foreach (array_keys($element['#webform_composite_elements']) as $key) {
      if ($key !== 'postal_code') {

        // Initial class for hidden fields.
        $element[$key]['#wrapper_attributes']['class'][] = 'address-lookup__field--initial';
      }

      // Generic class and data attribute.
      $element[$key]['#wrapper_attributes']['class'][] = 'address-lookup__field';
      $element[$key]['#wrapper_attributes']['data-key'] = $element['#webform_key'];
    }
    $element['#attached'] = [
      'library' => [
        'pca_webform/element.pca_webform.address.js',
      ],
      'drupalSettings' => [
        'loqate' => [
          'loqate' => [
            'key' => Loqate::getApiKey(),
          ],
        ],
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function getCompositeElements(array $element) {
    $drupal_translation = \Drupal::translation();
    $elements = [];
    $elements['address'] = [
      '#type' => 'textfield',
      '#title' => $drupal_translation
        ->translate('Address'),
    ];
    $elements['address_2'] = [
      '#type' => 'textfield',
      '#title' => $drupal_translation
        ->translate('Address 2'),
    ];
    $elements['city'] = [
      '#type' => 'textfield',
      '#title' => $drupal_translation
        ->translate('City/Town'),
    ];
    $elements['region'] = [
      '#type' => 'textfield',
      '#title' => $drupal_translation
        ->translate('Region'),
    ];
    $elements['state_province'] = [
      '#type' => 'select',
      '#title' => $drupal_translation
        ->translate('State/Province'),
      '#options' => 'state_province_names',
      '#empty_option' => '',
    ];
    $elements['postal_code'] = [
      '#type' => 'textfield',
      '#title' => $drupal_translation
        ->translate('Zip/Postal Code'),
    ];
    $elements['country'] = [
      '#type' => 'select',
      '#title' => $drupal_translation
        ->translate('Country'),
      '#options' => 'country_names',
      '#empty_option' => '',
    ];
    return $elements;
  }

}

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.
WebformAddressLoqate::getCompositeElements public static function Get a renderable array of webform elements. Overrides WebformCompositeBase::getCompositeElements
WebformAddressLoqate::getInfo public function Returns the element properties for this element. Overrides WebformCompositeBase::getInfo
WebformAddressLoqate::preRenderWebformCompositeFormElement public static function Adds form element theming to an element if its title or description is set. Overrides WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement
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::processWebformComposite public static function Processes a composite webform element. 2
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