class LoqatePcaAddress in Loqate 2.x

Same name in this branch

2.x src/Element/LoqatePcaAddress.php \Drupal\loqate\Element\LoqatePcaAddress
2.x src/Plugin/WebformElement/LoqatePcaAddress.php \Drupal\loqate\Plugin\WebformElement\LoqatePcaAddress

Same name and namespace in other branches

8 src/Element/LoqatePcaAddress.php \Drupal\loqate\Element\LoqatePcaAddress

Provides a simple Loqate PCA address form element.

Usage example:


$form['address'] = [
  '#type' => 'pca_address',
  '#pca_fields' => [
    [
      'element' => PcaAddressElement::ADDRESS_LOOKUP,
    ],
    [
      'element' => PcaAddressElement::LINE1,
      'field' => PcaAddressField::LINE1,
      'mode' => PcaAddressMode::POPULATE,
    ],
    ...
  ],
  '#pca_options' => [
    'key' => config_key_id, // Defaults to key from config.
    'countries' => ['codesList' => 'USA,CAN'],
    'setCountryByIP' => false,
    ...
  ],
  '#show_address_fields' => FALSE,
  '#allow_manual_input' => TRUE,
  ...
];

Plugin annotation

@FormElement("pca_address");

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\loqate\Element\LoqatePcaAddress uses PcaAddressElementTrait

Expanded class hierarchy of LoqatePcaAddress

1 #type use of LoqatePcaAddress

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

File

src/Element/LoqatePcaAddress.php, line 43

Namespace

Drupal\loqate\Element

View source

class LoqatePcaAddress extends FormElement {
  use PcaAddressElementTrait;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return $this
      ->buildElementGetInfo() + [
      '#process' => [
        [
          $class,
          'processAddress',
        ],
        [
          $class,
          'processPcaAddress',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateAddress',
        ],
      ],
      '#attached' => [
        'library' => [
          'loqate/element.pca_address.address.js',
        ],
      ],
      '#theme_wrappers' => [
        'container',
      ],
    ];
  }

  /**
   * Process the address fields.
   */
  public static function processAddress(array &$element, FormStateInterface $form_state, array &$complete_form) {

    // Ensure tree structure in output.
    $element['#tree'] = TRUE;
    $element[PcaAddressElement::LINE1] = [
      '#type' => 'textfield',
      '#title' => new TranslatableMarkup('Address Line 1'),
      '#default_value' => $element['#default_value'][PcaAddressElement::LINE1] ?? NULL,
      '#required' => TRUE,
    ];
    $element[PcaAddressElement::LINE2] = [
      '#type' => 'textfield',
      '#title' => new TranslatableMarkup('Address Line 2'),
      '#default_value' => $element['#default_value'][PcaAddressElement::LINE2] ?? NULL,
    ];
    $element[PcaAddressElement::POSTAL_CODE] = [
      '#type' => 'textfield',
      '#title' => new TranslatableMarkup('ZIP/Postal Code'),
      '#default_value' => $element['#default_value'][PcaAddressElement::POSTAL_CODE] ?? NULL,
      '#required' => TRUE,
      '#size' => 10,
    ];
    $element[PcaAddressElement::LOCALITY] = [
      '#type' => 'textfield',
      '#title' => new TranslatableMarkup('City/Town'),
      '#default_value' => $element['#default_value'][PcaAddressElement::LOCALITY] ?? NULL,
      '#required' => TRUE,
      '#size' => 30,
    ];
    $element[PcaAddressElement::ADMINISTRATIVE_AREA] = [
      '#type' => 'textfield',
      '#title' => new TranslatableMarkup('State/Province'),
      '#default_value' => $element['#default_value'][PcaAddressElement::ADMINISTRATIVE_AREA] ?? NULL,
      '#size' => 30,
    ];
    $element[PcaAddressElement::COUNTRY_CODE] = [
      '#type' => 'textfield',
      '#title' => new TranslatableMarkup('Country'),
      '#default_value' => $element['#default_value'][PcaAddressElement::COUNTRY_CODE] ?? NULL,
    ];
    return $element;
  }

  /**
   * Validates the address.
   */
  public static function validateAddress(&$element, FormStateInterface $form_state, &$complete_form) {

    // @TODO implement...
  }

}

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.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
LoqatePcaAddress::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
LoqatePcaAddress::processAddress	public static	function	Process the address fields.
LoqatePcaAddress::validateAddress	public static	function	Validates the address.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PcaAddressElementTrait::addAddressLabelField	private static	function	Adds a address label field.
PcaAddressElementTrait::addAddressLookupField	private static	function	Adds a lookup field.
PcaAddressElementTrait::buildElementGetInfo	public	function	Get the default settings for the field widget.
PcaAddressElementTrait::preparePcaFieldMapping	private static	function	Processes field mapping output.
PcaAddressElementTrait::preparePcaOptions	private static	function	Processes additional options and overrides.
PcaAddressElementTrait::processPcaAddress	public static	function	Process the PCA address form element.
PcaAddressElementTrait::wrapAddressFieldsInit	private static	function	Alters the original render array in favor of PCA.
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

class LoqatePcaAddress in Loqate 2.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation