class WebformAddressLoqate in Loqate 8

Same name in this branch

8 modules/pca_webform/src/Element/WebformAddressLoqate.php \Drupal\pca_webform\Element\WebformAddressLoqate
8 modules/pca_webform/src/Plugin/WebformElement/WebformAddressLoqate.php \Drupal\pca_webform\Plugin\WebformElement\WebformAddressLoqate

Same name and namespace in other branches

2.x modules/pca_webform/src/Plugin/WebformElement/WebformAddressLoqate.php \Drupal\pca_webform\Plugin\WebformElement\WebformAddressLoqate

Provides an 'address' element.

Plugin annotation


@WebformElement(
  id = "webform_address_loqate",
  label = @Translation("PCA address"),
  description = @Translation("Loqate API provides a form element to collect address information (street, city, state, zip)."),
  category = @Translation("Composite elements"),
  multiline = TRUE,
  composite = TRUE,
  states_wrapper = TRUE,
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityInjectionTrait
  - class \Drupal\webform\Plugin\WebformElement\WebformCompositeBase implements WebformElementAttachmentInterface, WebformElementCompositeInterface
    class \Drupal\pca_webform\Plugin\WebformElement\WebformAddressLoqate

Expanded class hierarchy of WebformAddressLoqate

File

modules/pca_webform/src/Plugin/WebformElement/WebformAddressLoqate.php, line 22

Namespace

Drupal\pca_webform\Plugin\WebformElement

View source

class WebformAddressLoqate extends WebformCompositeBase {

  /**
   * {@inheritdoc}
   */
  public function getPluginLabel() {
    return \Drupal::moduleHandler()
      ->moduleExists('pca_address') ? $this
      ->t('Basic PCA address') : parent::getPluginLabel();
  }

  /**
   * {@inheritdoc}
   */
  protected function formatHtmlItemValue(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
    return $this
      ->formatTextItemValue($element, $webform_submission, $options);
  }

  /**
   * {@inheritdoc}
   */
  protected function formatTextItemValue(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
    $value = $this
      ->getValue($element, $webform_submission, $options);
    $composite_elements = $element['#webform_composite_elements'];
    $location = '';

    // State/Province and Region can't both have values, since Region is only
    // used when S/P is not populatable.
    if (!empty($value['state_province'])) {
      if (!empty($value['city'])) {
        $location .= $value['city'];
      }
      $location .= $location ? ', ' : '';
      $location .= $this
        ->getValueFromOptions('state_province', $composite_elements, $value);
      if (!empty($value['postal_code'])) {
        $location .= $location ? '. ' : '';
        $location .= $value['postal_code'];
      }
      $value['location'] = $location;
      unset($value['city'], $value['region'], $value['postal_code']);
    }

    // Country preprocessing.
    if (!empty($value['country'])) {
      $value['country'] = $this
        ->getValueFromOptions('country', $composite_elements, $value);
    }
    $address_lines = [
      'address',
      'address_2',
      'location',
      'city',
      'region',
      'postal_code',
      'country',
    ];
    $display_lines = [];
    foreach ($address_lines as $line) {
      if (!empty($value[$line])) {
        $display_lines[$line] = $value[$line];
      }
    }
    return $display_lines;
  }

  /**
   * Helper function to return the human readable value of a possible select.
   *
   * @param $field
   *   The field key.
   * @param $composite_elements
   *   The composite element array.
   * @param $values
   *   The saved values array
   * @return string
   *   The human readable value of the field.
   */
  protected function getValueFromOptions($field, $composite_elements, $values) {
    $value = $values[$field];
    $field = $composite_elements[$field];
    $type = $field['#type'];
    $option_value = $type === 'select' ? $field['#options'][$value] : $value;
    if ($option_value instanceof TranslatableMarkup) {
      $option_value = (string) $option_value;
    }
    return $option_value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	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.
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.
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.
WebformAddressLoqate::formatHtmlItemValue	protected	function	Format composite element value into lines of text. Overrides WebformCompositeBase::formatHtmlItemValue
WebformAddressLoqate::formatTextItemValue	protected	function	Format composite element value into lines of text. Overrides WebformCompositeBase::formatTextItemValue
WebformAddressLoqate::getPluginLabel	public	function	Gets the label of the plugin instance. Overrides WebformElementBase::getPluginLabel
WebformAddressLoqate::getValueFromOptions	protected	function	Helper function to return the human readable value of a possible select.
WebformCompositeBase::$elementsManagedFiles	protected	property	Track managed file elements.
WebformCompositeBase::buildCompositeElementsTable	protected	function	Build the composite elements settings table.	2
WebformCompositeBase::buildConfigurationForm	public	function	Form constructor. Overrides WebformElementBase::buildConfigurationForm
WebformCompositeBase::buildExportHeader	public	function	Build an element's export header. Overrides WebformElementBase::buildExportHeader
WebformCompositeBase::buildExportOptionsForm	public	function	Get an element's export options webform. Overrides WebformElementBase::buildExportOptionsForm
WebformCompositeBase::buildExportRecord	public	function	Build an element's export row. Overrides WebformElementBase::buildExportRecord
WebformCompositeBase::defineDefaultMultipleProperties	protected	function	Define default multiple properties used by most elements. Overrides WebformElementBase::defineDefaultMultipleProperties	1
WebformCompositeBase::defineDefaultProperties	protected	function	Define an element's default properties. Overrides WebformElementBase::defineDefaultProperties	5
WebformCompositeBase::form	public	function	Gets the actual configuration webform array to be built. Overrides WebformElementBase::form	4
WebformCompositeBase::formatComposite	protected	function	Format a composite's sub element's value as HTML or plain text.
WebformCompositeBase::formatCompositeHtml	protected	function	Format a composite's sub element's value as HTML.
WebformCompositeBase::formatCompositeHtmlItems	protected	function	Format a composite as a list of HTML items.
WebformCompositeBase::formatCompositeText	protected	function	Format a composite's sub element's value as plain text.
WebformCompositeBase::formatCompositeTextItems	protected	function	Format a composite as a list of plain text items.
WebformCompositeBase::formatCustomItem	protected	function	Format an element's item using custom HTML or plain text. Overrides WebformElementBase::formatCustomItem
WebformCompositeBase::formatHtml	public	function	Format an element's value as HTML. Overrides WebformElementBase::formatHtml
WebformCompositeBase::formatHtmlItem	protected	function	Format an element's value as HTML. Overrides WebformElementBase::formatHtmlItem	2
WebformCompositeBase::formatHtmlItems	protected	function	Format an element's items as HTML. Overrides WebformElementBase::formatHtmlItems
WebformCompositeBase::formatTableColumn	public	function	Format an element's table column value. Overrides WebformElementBase::formatTableColumn
WebformCompositeBase::formatText	public	function	Format an element's value as plain text. Overrides WebformElementBase::formatText
WebformCompositeBase::formatTextItem	protected	function	Format an element's value as text. Overrides WebformElementBase::formatTextItem	1
WebformCompositeBase::formatTextItems	protected	function	Format an element's items as text. Overrides WebformElementBase::formatTextItems
WebformCompositeBase::getAttachments	public	function	Get email attachments. Overrides WebformElementAttachmentInterface::getAttachments
WebformCompositeBase::getCompositeElementOptions	protected	function	Get webform option keys for composite element based on the composite element's key.	1
WebformCompositeBase::getCompositeElements	public	function	Get composite element.
WebformCompositeBase::getConfigurationFormProperties	public	function	Get an associative array of element properties from configuration webform. Overrides WebformElementBase::getConfigurationFormProperties
WebformCompositeBase::getElementSelectorOptions	public	function	Get an element's selectors as options. Overrides WebformElementBase::getElementSelectorOptions
WebformCompositeBase::getElementSelectorSourceValues	public	function	Get an element's selectors source values. Overrides WebformElementBase::getElementSelectorSourceValues
WebformCompositeBase::getExportDefaultOptions	public	function	Get an element's default export options. Overrides WebformElementBase::getExportDefaultOptions
WebformCompositeBase::getInitializedCompositeElement	public	function	Get initialized composite element.
WebformCompositeBase::getItemFormats	public	function	Get an element's available single value formats. Overrides WebformElementBase::getItemFormats	1
WebformCompositeBase::getItemsDefaultFormat	public	function	Get an element's default multiple value format name. Overrides WebformElementBase::getItemsDefaultFormat
WebformCompositeBase::getItemsFormats	public	function	Get an element's available multiple value formats. Overrides WebformElementBase::getItemsFormats
WebformCompositeBase::getManagedFileIdsFromData	protected	function	Get composite element's file ids from data array.
WebformCompositeBase::getManagedFiles	public	function	Get composite's managed file elements.
WebformCompositeBase::getRelatedTypes	public	function	Get related element types. Overrides WebformElementBase::getRelatedTypes
WebformCompositeBase::getTableColumn	public	function	Get element's table column(s) settings. Overrides WebformElementBase::getTableColumn
WebformCompositeBase::getTestValues	public	function	Get test values for an element. Overrides WebformElementBase::getTestValues	3
WebformCompositeBase::hasManagedFiles	public	function	Determine if the element is or includes a managed_file upload element. Overrides WebformElementBase::hasManagedFiles
WebformCompositeBase::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides WebformElementBase::initialize	1
WebformCompositeBase::initializeCompositeElements	public	function	Initialize and cache #webform_composite_elements.	2
WebformCompositeBase::initializeCompositeElementsRecursive	protected	function	Initialize a composite's elements recursively.
WebformCompositeBase::isSupportedElementType	public static	function	Determine if element type is supported by custom composite elements.
WebformCompositeBase::postDelete	public	function	Delete any additional value associated with an element. Overrides WebformElementBase::postDelete
WebformCompositeBase::postSave	public	function	Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementBase::postSave
WebformCompositeBase::prepare	public	function	Prepare an element to be rendered within a webform. Overrides WebformElementBase::prepare	2
WebformCompositeBase::prepareMultipleWrapper	protected	function	Set multiple element wrapper. Overrides WebformElementBase::prepareMultipleWrapper	1
WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set.	1
WebformElementBase::$configFactory	protected	property	The configuration factory.
WebformElementBase::$currentUser	protected	property	The current user.
WebformElementBase::$defaultProperties	protected	property	An associative array of an element's default properties names and values.
WebformElementBase::$elementInfo	protected	property	A element info manager.
WebformElementBase::$elementManager	protected	property	The webform element manager.
WebformElementBase::$entityTypeManager	protected	property	The entity type manager.
WebformElementBase::$librariesManager	protected	property	The webform libraries manager.
WebformElementBase::$logger	protected	property	A logger instance.
WebformElementBase::$submissionStorage	protected	property	The webform submission storage.
WebformElementBase::$tokenManager	protected	property	The token manager.
WebformElementBase::$translatableProperties	protected	property	An indexed array of an element's translated properties.
WebformElementBase::alterForm	public	function	Alter an element's associated form. Overrides WebformElementInterface::alterForm	1
WebformElementBase::build	protected	function	Build an element as text or HTML.	4
WebformElementBase::buildConfigurationFormTabs	protected	function	Build configuration form tabs.	1
WebformElementBase::buildHtml	public	function	Build an element as HTML element. Overrides WebformElementInterface::buildHtml	2
WebformElementBase::buildText	public	function	Build an element as text element. Overrides WebformElementInterface::buildText	1
WebformElementBase::checkAccessRule	protected	function	Checks an access rule against a user account's roles and id.
WebformElementBase::checkAccessRules	public	function	Check element access (rules). Overrides WebformElementInterface::checkAccessRules
WebformElementBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
WebformElementBase::defineDefaultBaseProperties	protected	function	Define default base properties used by all elements.	4
WebformElementBase::defineTranslatableProperties	protected	function	Define an element's translatable properties.	15
WebformElementBase::displayDisabledWarning	public	function	Display element disabled warning. Overrides WebformElementInterface::displayDisabledWarning	1
WebformElementBase::finalize	public	function	Finalize an element to be rendered within a webform. Overrides WebformElementInterface::finalize	1
WebformElementBase::format	protected	function	Format an element's value as HTML or plain text.	2
WebformElementBase::formatCustomItems	protected	function	Format an element's items using custom HTML or plain text.
WebformElementBase::getAdminLabel	public	function	Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface::getAdminLabel
WebformElementBase::getConfigurationFormProperty	protected	function	Get configuration property value.	1
WebformElementBase::getDefaultBaseProperties Deprecated	protected	function	Get default base properties used by all elements.
WebformElementBase::getDefaultKey	public	function	Gets the element's default key. Overrides WebformElementInterface::getDefaultKey	1
WebformElementBase::getDefaultMultipleProperties Deprecated	protected	function	Get default multiple properties used by most elements.
WebformElementBase::getDefaultProperties	public	function	Get default properties. Overrides WebformElementInterface::getDefaultProperties
WebformElementBase::getDefaultProperty	public	function	Get an element's default property value. Overrides WebformElementInterface::getDefaultProperty
WebformElementBase::getElementInfoDefaultProperty	protected	function	Get a render element's default property.
WebformElementBase::getElementProperty	public	function	Get an element's property value. Overrides WebformElementInterface::getElementProperty
WebformElementBase::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options.	9
WebformElementBase::getElementSelectorInputValue	public	function	Get an element's (sub)input selector value. Overrides WebformElementInterface::getElementSelectorInputValue	5
WebformElementBase::getElementStateOptions	public	function	Get an element's supported states as options. Overrides WebformElementInterface::getElementStateOptions	1
WebformElementBase::getFormElementClassDefinition	public	function	Get the Webform element's form element class definition. Overrides WebformElementInterface::getFormElementClassDefinition
WebformElementBase::getFormInlineContainer	protected	function	Get form--inline container which is used for side-by-side element layout.
WebformElementBase::getInfo	public	function	Retrieves the default properties for the defined element type. Overrides WebformElementInterface::getInfo
WebformElementBase::getItemDefaultFormat	public	function	Get an element's default single value format name. Overrides WebformElementInterface::getItemDefaultFormat	23
WebformElementBase::getItemFormat	public	function	Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemFormat	1
WebformElementBase::getItemsFormat	public	function	Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface::getItemsFormat
WebformElementBase::getKey	public	function	Get an element's key/name. Overrides WebformElementInterface::getKey
WebformElementBase::getLabel	public	function	Get an element's label (#title or #webform_key). Overrides WebformElementInterface::getLabel
WebformElementBase::getOffCanvasWidth	public	function	Get configuration form's off-canvas width. Overrides WebformElementInterface::getOffCanvasWidth	1
WebformElementBase::getPluginApiLink	public	function	Get link to element's API documentation. Overrides WebformElementInterface::getPluginApiLink
WebformElementBase::getPluginApiUrl	public	function	Get the URL for the element's API documentation. Overrides WebformElementInterface::getPluginApiUrl
WebformElementBase::getPluginCategory	public	function	Gets the category of the plugin instance. Overrides WebformElementInterface::getPluginCategory
WebformElementBase::getPluginDescription	public	function	Gets the description of the plugin instance. Overrides WebformElementInterface::getPluginDescription
WebformElementBase::getRawValue	public	function	Get an element's submission raw value. Overrides WebformElementInterface::getRawValue
WebformElementBase::getTranslatableProperties	public	function	Get translatable properties. Overrides WebformElementInterface::getTranslatableProperties
WebformElementBase::getTypeName	public	function	Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface::getTypeName
WebformElementBase::getValue	public	function	Get an element's submission value. Overrides WebformElementInterface::getValue	1
WebformElementBase::hasCompositeFormElementWrapper	protected	function	Determine if the element has a composite field wrapper.
WebformElementBase::hasMultipleValues	public	function	Checks if the element value has multiple values. Overrides WebformElementInterface::hasMultipleValues	6
WebformElementBase::hasMultipleWrapper	public	function	Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface::hasMultipleWrapper	3
WebformElementBase::hasProperty	public	function	Determine if the element supports a specified property. Overrides WebformElementInterface::hasProperty
WebformElementBase::hasValue	public	function	Determine if an element's has a submission value. Overrides WebformElementInterface::hasValue	2
WebformElementBase::hasWrapper	public	function	Checks if the element has a wrapper. Overrides WebformElementInterface::hasWrapper
WebformElementBase::hiddenElementAfterBuild	public static	function	Webform element #after_build callback.
WebformElementBase::isComposite	public	function	Checks if the element is a composite element. Overrides WebformElementInterface::isComposite
WebformElementBase::isContainer	public	function	Checks if the element is a container that can contain elements. Overrides WebformElementInterface::isContainer	9
WebformElementBase::isDisabled	public	function	Checks if the element is disabled. Overrides WebformElementInterface::isDisabled
WebformElementBase::isEmptyExcluded	public	function	Checks if an empty element is excluded. Overrides WebformElementInterface::isEmptyExcluded	1
WebformElementBase::isEnabled	public	function	Checks if the element is enabled. Overrides WebformElementInterface::isEnabled	1
WebformElementBase::isExcluded	public	function	Checks if the element is excluded via webform.settings. Overrides WebformElementInterface::isExcluded
WebformElementBase::isHidden	public	function	Checks if the element is hidden. Overrides WebformElementInterface::isHidden	2
WebformElementBase::isInput	public	function	Checks if the element carries a value. Overrides WebformElementInterface::isInput	11
WebformElementBase::isMultiline	public	function	Checks if the element value could contain multiple lines. Overrides WebformElementInterface::isMultiline	2
WebformElementBase::isRoot	public	function	Checks if the element is a root element. Overrides WebformElementInterface::isRoot	3
WebformElementBase::postCreate	public	function	Acts on a webform submission element after it is created. Overrides WebformElementInterface::postCreate	1
WebformElementBase::postLoad	public	function	Acts on loaded webform submission. Overrides WebformElementInterface::postLoad	1
WebformElementBase::preCreate	public	function	Changes the values of an entity before it is created. Overrides WebformElementInterface::preCreate	1
WebformElementBase::preDelete	public	function		1
WebformElementBase::prefixExportHeader	protected	function	Prefix an element's export header.
WebformElementBase::prepareCompositeFormElement	protected	function	Replace Core's composite #pre_render with Webform's composite #pre_render.
WebformElementBase::prepareElementPreRenderCallbacks	protected	function	Prepare an element's pre render callbacks.	3
WebformElementBase::prepareElementValidateCallbacks	protected	function	Prepare an element's validation callbacks.	8
WebformElementBase::prepareWrapper	protected	function	Set an elements #states and flexbox wrapper.	1
WebformElementBase::preRenderFixFlexboxWrapper	public static	function	Fix flexbox wrapper.
WebformElementBase::preRenderFixStatesWrapper	public static	function	Fix state wrapper.
WebformElementBase::preSave	public	function	Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface::preSave	4
WebformElementBase::preview	public	function	Generate a renderable preview of the element. Overrides WebformElementInterface::preview	37
WebformElementBase::replaceTokens	public	function	Replace tokens for all element properties. Overrides WebformElementInterface::replaceTokens
WebformElementBase::setConfigurationFormDefaultValue	protected	function	Set an element's configuration webform element default value.	2
WebformElementBase::setConfigurationFormDefaultValueRecursive	protected	function	Set configuration webform default values recursively.
WebformElementBase::setDefaultValue	public	function	Set an element's default value using saved data. Overrides WebformElementInterface::setDefaultValue	7
WebformElementBase::setElementDefaultCallback	protected	function	Set element's default callback.
WebformElementBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
WebformElementBase::supportsMultipleValues	public	function	Checks if the element supports multiple values. Overrides WebformElementInterface::supportsMultipleValues	8
WebformElementBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks	1
WebformElementBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	6
WebformElementBase::validateMinlength	public static	function	Form API callback. Validate element #minlength value.
WebformElementBase::validateMultiple	public static	function	Form API callback. Validate element #multiple > 1 value.
WebformElementBase::validateUnique	public static	function	Form API callback. Validate element #unique value.
WebformElementBase::validateUniqueMultiple	public static	function	Form API callback. Validate element #unique multiple values.
WebformElementBase::__construct	public	function	Constructs a WebformElementBase object. Overrides PluginBase::__construct	2
WebformEntityInjectionTrait::$webform	protected	property	The webform.
WebformEntityInjectionTrait::$webformSubmission	protected	property	The webform submission.
WebformEntityInjectionTrait::getWebform	public	function	Get the webform that this handler is attached to.
WebformEntityInjectionTrait::getWebformSubmission	public	function	Set webform and webform submission entity.
WebformEntityInjectionTrait::resetEntities	public	function	Reset webform and webform submission entity.
WebformEntityInjectionTrait::setEntities	public	function
WebformEntityInjectionTrait::setWebform	public	function	Set the webform that this is handler is attached to.
WebformEntityInjectionTrait::setWebformSubmission	public	function	Get the webform submission that this handler is handling.

You are here

class WebformAddressLoqate in Loqate 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation