class AddressPcaAddress in Loqate 8

Provides an advanced PCA address form element.

Usage example:

$form['address'] = [
  '#type' => 'pca_address_advanced',
  '#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_advanced");

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\address\Element\Address
          • class \Drupal\pca_address\Element\AddressPcaAddress uses PcaAddressElementTrait

See also

\Drupal\address\Element\Address

File

modules/pca_address/src/Element/AddressPcaAddress.php, line 42

Namespace

Drupal\pca_address\Element

class AddressPcaAddress extends Address {
  use PcaAddressElementTrait;

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

}

Members

Name	Modifiers	Type	Description	Overrides
Address::addressElements	protected static	function	Builds the format-specific address elements.
Address::ajaxRefresh	public static	function	Ajax callback.
Address::applyDefaults	public static	function	Ensures all keys are set on the provided value.
Address::clearValues	public static	function	Clears dependent form values when the country or subdivision changes.
Address::groupElements	public static	function	Groups elements with the same #group so that they can be inlined.
Address::processAddress	public static	function	Processes the address form element.
Address::processSubdivisionElements	protected static	function	Processes the subdivision elements, adding predefined values where found.
Address::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
AddressPcaAddress::getInfo	public	function	Returns the element properties for this element. Overrides Address::getInfo
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	92
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.	1
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.