You are here

class WebformLocationGeocomplete in Webform 6.x

Same name in this branch
  1. 6.x modules/webform_location_geocomplete/src/Element/WebformLocationGeocomplete.php \Drupal\webform_location_geocomplete\Element\WebformLocationGeocomplete
  2. 6.x modules/webform_location_geocomplete/src/Plugin/WebformElement/WebformLocationGeocomplete.php \Drupal\webform_location_geocomplete\Plugin\WebformElement\WebformLocationGeocomplete
Same name and namespace in other branches
  1. 8.5 modules/webform_location_geocomplete/src/Element/WebformLocationGeocomplete.php \Drupal\webform_location_geocomplete\Element\WebformLocationGeocomplete

Provides a webform element for a location geocomplete element.

Plugin annotation

@FormElement("webform_location_geocomplete");

Hierarchy

Expanded class hierarchy of WebformLocationGeocomplete

File

modules/webform_location_geocomplete/src/Element/WebformLocationGeocomplete.php, line 13

Namespace

Drupal\webform_location_geocomplete\Element
View source
class WebformLocationGeocomplete extends WebformLocationBase {

  /**
   * {@inheritdoc}
   */
  protected static $name = 'geocomplete';

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

  /**
   * {@inheritdoc}
   */
  public static function getLocationAttributes() {
    return [
      'lat' => t('Latitude'),
      'lng' => t('Longitude'),
      'location' => t('Location'),
      'formatted_address' => t('Formatted Address'),
      'street_address' => t('Street Address'),
      'street_number' => t('Street Number'),
      'subpremise' => t('Unit'),
      'postal_code' => t('Postal Code'),
      'locality' => t('Locality'),
      'sublocality' => t('City'),
      'administrative_area_level_1' => t('State/Province'),
      'country' => t('Country'),
      'country_short' => t('Country Code'),
    ];
  }

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

    // Add Google Maps API key which is required by
    // https://maps.googleapis.com/maps/api/js?key=API_KEY&libraries=places
    // @see webform_location_geocomplete_js_alter()
    if (!empty($element['#api_key'])) {
      $api_key = $element['#api_key'];
    }
    else {

      /** @var \Drupal\webform\WebformThirdPartySettingsManagerInterface $third_party_settings_manager */
      $third_party_settings_manager = \Drupal::service('webform.third_party_settings_manager');
      $api_key = $third_party_settings_manager
        ->getThirdPartySetting('webform_location_geocomplete', 'default_google_maps_api_key') ?: '';
    }
    $element['#attached']['drupalSettings']['webform']['location']['geocomplete']['api_key'] = $api_key;

    // Attach library.
    $element['#attached']['library'][] = 'webform_location_geocomplete/webform_location_geocomplete.element';
    return $element;
  }

}

Members

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