You are here

class GeolocationMapLocation in Geolocation Field 8.2

Same name and namespace in other branches
  1. 8.3 src/Element/GeolocationMapLocation.php \Drupal\geolocation\Element\GeolocationMapLocation

Provides a render element for a single geolocation map location.

Usage example:

$form['map'] = [
  '#type' => 'geolocation_map_location',
  '#prefix' => $this
    ->t('Geolocation Map Render Element'),
  '#description' => $this
    ->t('Render element type "geolocation_map"'),
  '#title' => NULL,
  '#position' => NULL,
  '#id' => NULL,
  '#hidden' => NULL,
  '#icon' => NULL,
  '#label' => NULL,
];

Plugin annotation

@FormElement("geolocation_map_location");

Hierarchy

Expanded class hierarchy of GeolocationMapLocation

4 #type uses of GeolocationMapLocation
CommonMapBase::getLocationsFromRow in src/Plugin/views/style/CommonMapBase.php
Render array from views result row.
DemoRenderElementController::renderElementDemo in modules/geolocation_demo/src/Controller/DemoRenderElementController.php
Return the non-functional geocoding widget form.
GeolocationBlock::build in src/Plugin/Block/GeolocationBlock.php
Builds and returns the renderable array for this block plugin.
GeolocationMapFormatterBase::viewElements in src/Plugin/Field/FieldFormatter/GeolocationMapFormatterBase.php
Builds a renderable array for a field value.

File

src/Element/GeolocationMapLocation.php, line 29

Namespace

Drupal\geolocation\Element
View source
class GeolocationMapLocation extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    $info = [
      '#process' => [
        [
          $class,
          'processGroup',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderGroup',
        ],
        [
          $this,
          'preRenderLocation',
        ],
      ],
      '#title' => NULL,
      '#position' => NULL,
      '#id' => NULL,
      '#hidden' => NULL,
      '#icon' => NULL,
      '#label' => NULL,
    ];
    return $info;
  }

  /**
   * Map element.
   *
   * @param array $render_array
   *   Element.
   *
   * @return array
   *   Renderable map.
   */
  public function preRenderLocation(array $render_array) {
    $render_array['#theme'] = 'geolocation_map_location';
    if (empty($render_array['#id'])) {
      $id = uniqid();
      $render_array['#id'] = $id;
    }
    foreach (Element::children($render_array) as $child) {
      $render_array['#children'][] = $render_array[$child];
    }
    if (empty($render_array['#attributes'])) {
      $render_array['#attributes'] = [];
    }
    $render_array['#attributes'] = new Attribute($render_array['#attributes']);
    $render_array['#attributes']
      ->addClass('geolocation-location');
    $render_array['#attributes']
      ->addClass('js-hide');
    if (!empty($render_array['#id'])) {
      $render_array['#attributes']
        ->setAttribute('id', $render_array['#id']);
    }
    $render_array['#attributes']
      ->setAttribute('data-lat', $render_array['#position']['lat']);
    $render_array['#attributes']
      ->setAttribute('data-lng', $render_array['#position']['lng']);
    if (empty($render_array['#hidden'])) {
      $render_array['#attributes']
        ->setAttribute('data-set-marker', 'true');
      if (!empty($render_array['#icon'])) {
        $render_array['#attributes']
          ->setAttribute('data-icon', $render_array['#icon']);
      }
      if (!empty($render_array['#label'])) {
        $render_array['#attributes']
          ->setAttribute('data-label', $render_array['#label']);
      }
    }
    return $render_array;
  }

}

Members

Namesort descending 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
GeolocationMapLocation::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
GeolocationMapLocation::preRenderLocation public function Map element.
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.