abstract class WebformLocationBase in Webform 8.5

Provides a webform base element for a location element.

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\webform\Element\WebformCompositeBase implements WebformCompositeInterface uses WebformCompositeFormElementTrait
          • class \Drupal\webform\Element\WebformLocationBase

1 file declares its use of WebformLocationBase

WebformLocationGeocomplete.php in modules/webform_location_geocomplete/src/Element/WebformLocationGeocomplete.php

File

src/Element/WebformLocationBase.php, line 11

Namespace

Drupal\webform\Element

abstract class WebformLocationBase extends WebformCompositeBase {

  /**
   * The location element's class name.
   *
   * @var string
   */
  protected static $name;

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

  /**
   * Get location attributes.
   *
   * @return array
   *   An associative array container location attribute name and titles.
   */
  public static function getLocationAttributes() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public static function getCompositeElements(array $element) {
    $elements = [];
    $elements['value'] = [
      '#type' => 'textfield',
      '#title' => t('Address'),
      '#attributes' => [
        'class' => [
          'webform-location-' . static::$name,
        ],
      ],
    ];
    $attributes = static::getLocationAttributes();
    foreach ($attributes as $name => $title) {
      $elements[$name] = [
        '#title' => $title,
        '#type' => 'textfield',
        '#error_no_message' => TRUE,
        '#attributes' => [
          'data-webform-location-' . static::$name . '-attribute' => $name,
        ],
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function preRenderWebformCompositeFormElement($element) {

    // Hide location element webform display only if #geolocation is also set.
    if (!empty($element['#hidden']) && !empty($element['#geolocation'])) {
      $element['#wrapper_attributes']['style'] = 'display: none';
    }
    $element = WebformCompositeBase::preRenderWebformCompositeFormElement($element);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function processWebformComposite(&$element, FormStateInterface $form_state, &$complete_form) {
    $element = parent::processWebformComposite($element, $form_state, $complete_form);

    // Composite elements should always be displayed and rendered so that
    // location data can be populated, so #access is really just converting the
    // readonly elements to hidden elements.
    $composite_elements = static::getCompositeElements($element);
    foreach ($composite_elements as $composite_key => $composite_element) {
      if ($composite_key !== 'value') {
        if (!Element::isVisibleElement($element[$composite_key])) {
          unset($element[$composite_key]['#access']);
          unset($element[$composite_key]['#pre_render']);
          $element[$composite_key]['#type'] = 'hidden';
        }
        elseif (!empty($element['#hidden']) && !empty($element['#geolocation'])) {
          unset($element[$composite_key]['#pre_render']);
          $element[$composite_key]['#type'] = 'hidden';
        }
        else {
          $element[$composite_key]['#wrapper_attributes']['class'][] = 'webform-readonly';
          $element[$composite_key]['#readonly'] = 'readonly';
        }
      }
    }

    // Get shared properties.
    $shared_properties = [
      '#required',
      '#placeholder',
    ];
    $element['value'] += array_intersect_key($element, array_combine($shared_properties, $shared_properties));

    // Set Geolocation detection attribute.
    if (!empty($element['#geolocation'])) {
      $element['value']['#attributes']['data-webform-location-' . static::$name . '-geolocation'] = 'data-webform-location-' . static::$name . '-geolocation';
    }

    // Set Map attribute.
    if (!empty($element['#map']) && empty($element['#hidden'])) {
      $element['value']['#attributes']['data-webform-location-' . static::$name . '-map'] = 'data-webform-location-' . static::$name . '-map';
    }
    $element += [
      '#element_validate' => [],
    ];
    array_unshift($element['#element_validate'], [
      get_called_class(),
      'validateWebformLocation',
    ]);
    return $element;
  }

  /**
   * Validates location.
   */
  public static function validateWebformLocation(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = $element['#value'];
    if (Element::isVisibleElement($element) && !empty($element['#required']) && empty($value['lat'])) {
      $t_args = [
        '@title' => !empty($element['#title']) ? $element['#title'] : t('Location'),
      ];
      $form_state
        ->setError($element['value'], t('The @title is not valid.', $t_args));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
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
WebformLocationBase::$name	protected static	property	The location element's class name.	2
WebformLocationBase::getCompositeElements	public static	function	Get a renderable array of webform elements. Overrides WebformCompositeBase::getCompositeElements
WebformLocationBase::getInfo	public	function	Returns the element properties for this element. Overrides WebformCompositeBase::getInfo	2
WebformLocationBase::getLocationAttributes	public static	function	Get location attributes.	2
WebformLocationBase::preRenderWebformCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set. Overrides WebformCompositeFormElementTrait::preRenderWebformCompositeFormElement
WebformLocationBase::processWebformComposite	public static	function	Processes a composite webform element. Overrides WebformCompositeBase::processWebformComposite	2
WebformLocationBase::validateWebformLocation	public static	function	Validates location.