class YamlFormLocation in YAML Form 8

Same name in this branch

8 src/Element/YamlFormLocation.php \Drupal\yamlform\Element\YamlFormLocation
8 src/Plugin/YamlFormElement/YamlFormLocation.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormLocation

Provides a form element for a location element.

Plugin annotation

@FormElement("yamlform_location");

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\yamlform\Element\YamlFormCompositeBase uses CompositeFormElementTrait
    class \Drupal\yamlform\Element\YamlFormLocation

Expanded class hierarchy of YamlFormLocation

1 file declares its use of YamlFormLocation

YamlFormLocation.php in src/Plugin/YamlFormElement/YamlFormLocation.php

File

src/Element/YamlFormLocation.php, line 12

Namespace

Drupal\yamlform\Element

View source

class YamlFormLocation extends YamlFormCompositeBase {

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

  /**
   * {@inheritdoc}
   */
  public static function getCompositeElements() {

    // @see https://developers.google.com/maps/documentation/javascript/geocoding#GeocodingAddressTypes
    $attributes = [];
    $attributes['lat'] = [
      '#title' => t('Latitude'),
    ];
    $attributes['lng'] = [
      '#title' => t('Longitude'),
    ];
    $attributes['location'] = [
      '#title' => t('Location'),
    ];
    $attributes['formatted_address'] = [
      '#title' => t('Formatted Address'),
    ];
    $attributes['street_address'] = [
      '#title' => t('Street Address'),
    ];
    $attributes['street_number'] = [
      '#title' => t('Street Number'),
    ];
    $attributes['postal_code'] = [
      '#title' => t('Postal Code'),
    ];
    $attributes['locality'] = [
      '#title' => t('Locality'),
    ];
    $attributes['sublocality'] = [
      '#title' => t('City'),
    ];
    $attributes['administrative_area_level_1'] = [
      '#title' => t('State/Province'),
    ];
    $attributes['country'] = [
      '#title' => t('Country'),
    ];
    $attributes['country_short'] = [
      '#title' => t('Country Code'),
    ];
    foreach ($attributes as $name => &$attribute_element) {
      $attribute_element['#type'] = 'textfield';
      $attribute_element['#attributes'] = [
        'data-yamlform-location-attribute' => $name,
      ];
    }
    $elements = [];
    $elements['value'] = [
      '#type' => 'textfield',
      '#title' => t('Address'),
      '#attributes' => [
        'class' => [
          'yamlform-location-geocomplete',
        ],
      ],
    ];
    $elements += $attributes;
    return $elements;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public static function processYamlFormComposite(&$element, FormStateInterface $form_state, &$complete_form) {
    $element = parent::processYamlFormComposite($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();
    foreach ($composite_elements as $composite_key => $composite_element) {
      if ($composite_key != 'value') {
        if (isset($element[$composite_key]['#access']) && $element[$composite_key]['#access'] === FALSE) {
          unset($element[$composite_key]['#access']);
          $element[$composite_key]['#type'] = 'hidden';
        }
        elseif (!empty($element['#hidden']) && !empty($element['#geolocation'])) {
          $element[$composite_key]['#type'] = 'hidden';
        }
        else {
          $element[$composite_key]['#attributes']['class'][] = 'yamlform-readonly';
          $element[$composite_key]['#readonly'] = 'readonly';
        }
      }
    }

    // Set required.
    if (isset($element['#required'])) {
      $element['value']['#required'] = $element['#required'];
    }

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

    // Writing script tags (only once) directly into the page's output to ensure
    // that Google Maps APi script is loaded using the proper API key.
    static $google_api;
    if (empty($google_api)) {
      $api_key = !empty($element['#api_key']) ? $element['#api_key'] : \Drupal::config('yamlform.settings')
        ->get('elements.default_google_maps_api_key');
      $element['script'] = [
        '#markup' => '<script src="https://maps.googleapis.com/maps/api/js?key=' . $api_key . '&libraries=places"></script>',
        '#allowed_tags' => [
          'script',
        ],
      ];
      $google_api = TRUE;
    }
    $element['#attached']['library'][] = 'yamlform/yamlform.element.location';
    $element['#element_validate'] = [
      [
        get_called_class(),
        'validateYamlFormLocation',
      ],
    ];
    return $element;
  }

  /**
   * Validates location.
   */
  public static function validateYamlFormLocation(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = $element['#value'];
    $has_access = !isset($element['#access']) || $element['#access'] === TRUE;
    if ($has_access && !empty($element['#required']) && empty($value['location'])) {
      $t_args = [
        '@title' => !empty($element['#title']) ? $element['#title'] : t('Location'),
      ];
      $form_state
        ->setError($element, 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.
YamlFormCompositeBase::validateYamlFormComposite	public static	function	Validates a composite element.
YamlFormCompositeBase::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
YamlFormLocation::getCompositeElements	public static	function	Get a renderable array of form elements. Overrides YamlFormCompositeBase::getCompositeElements
YamlFormLocation::getInfo	public	function	Returns the element properties for this element. Overrides YamlFormCompositeBase::getInfo
YamlFormLocation::preRenderCompositeFormElement	public static	function	Adds form element theming to an element if its title or description is set. Overrides YamlFormCompositeBase::preRenderCompositeFormElement
YamlFormLocation::processYamlFormComposite	public static	function	Processes a composite form element. Overrides YamlFormCompositeBase::processYamlFormComposite
YamlFormLocation::validateYamlFormLocation	public static	function	Validates location.

You are here

class YamlFormLocation in YAML Form 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation