LeafletDefaultFormatter.php in Leaflet 2.0.x

Namespace

Drupal\leaflet\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/LeafletDefaultFormatter.php

<?php

namespace Drupal\leaflet\Plugin\Field\FieldFormatter;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Render\BubbleableMetadata;
use Drupal\Core\Render\RenderContext;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Leaflet\LeafletService;
use Drupal\leaflet\LeafletSettingsElementsTrait;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Utility\Token;
use Drupal\core\Render\Renderer;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Component\Utility\Html;
use Drupal\Core\Utility\LinkGeneratorInterface;

/**
 * Plugin implementation of the 'leaflet_default' formatter.
 *
 * @FieldFormatter(
 *   id = "leaflet_formatter_default",
 *   label = @Translation("Leaflet Map"),
 *   field_types = {
 *     "geofield"
 *   }
 * )
 */
class LeafletDefaultFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
  use LeafletSettingsElementsTrait;

  /**
   * The Default Settings.
   *
   * @var array
   */
  protected $defaultSettings;

  /**
   * Leaflet service.
   *
   * @var \Drupal\Leaflet\LeafletService
   */
  protected $leafletService;

  /**
   * The EntityField Manager service.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The token service.
   *
   * @var \Drupal\core\Utility\Token
   */
  protected $token;

  /**
   * The renderer service.
   *
   * @var \Drupal\core\Render\Renderer
   */
  protected $renderer;

  /**
   * The module handler to invoke the alter hook.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The Link generator Service.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $link;

  /**
   * LeafletDefaultFormatter constructor.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Leaflet\LeafletService $leaflet_service
   *   The Leaflet service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The Entity Field Manager.
   * @param \Drupal\core\Utility\Token $token
   *   The token service.
   * @param \Drupal\core\Render\Renderer $renderer
   *   The renderer service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
   *   The Link Generator service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LeafletService $leaflet_service, EntityFieldManagerInterface $entity_field_manager, Token $token, Renderer $renderer, ModuleHandlerInterface $module_handler, LinkGeneratorInterface $link_generator) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->defaultSettings = self::getDefaultSettings();
    $this->leafletService = $leaflet_service;
    $this->entityFieldManager = $entity_field_manager;
    $this->token = $token;
    $this->renderer = $renderer;
    $this->moduleHandler = $module_handler;
    $this->link = $link_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('leaflet.service'), $container
      ->get('entity_field.manager'), $container
      ->get('token'), $container
      ->get('renderer'), $container
      ->get('module_handler'), $container
      ->get('link_generator'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return self::getDefaultSettings() + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settings = $this
      ->getSettings();
    $form['#tree'] = TRUE;

    // Get the Cardinality set for the Formatter Field.
    $field_cardinality = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
    $elements = parent::settingsForm($form, $form_state);
    $field_name = $this->fieldDefinition
      ->getName();

    // Set Replacement Patterns Element.
    $this
      ->setReplacementPatternsElement($elements);
    if ($field_cardinality !== 1) {
      $elements['multiple_map'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Multiple Maps'),
        '#description' => $this
          ->t('Check this option if you want to render a single Map for every single Geo Point.'),
        '#default_value' => $settings['multiple_map'],
        '#return_value' => 1,
      ];
    }
    else {
      $elements['multiple_map'] = [
        '#type' => 'hidden',
        '#value' => 0,
      ];
    }
    $elements['popup'] = [
      '#title' => $this
        ->t('Popup Infowindow'),
      '#description' => $this
        ->t('Show a Popup Infowindow on Marker click, with custom content.'),
      '#type' => 'checkbox',
      '#default_value' => $settings['popup'],
    ];
    $elements['popup_content'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Popup content'),
      '#description' => $this
        ->t('Define the custom content for the Pop Infowindow. If empty the Content Title will be output.<br>See "REPLACEMENT PATTERNS" above for available replacements.'),
      '#default_value' => $settings['popup_content'],
      '#states' => [
        'visible' => [
          'input[name="fields[' . $field_name . '][settings_edit_form][settings][popup]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];

    // Generate the Leaflet Map General Settings.
    $this
      ->generateMapGeneralSettings($elements, $settings);

    // Generate the Leaflet Map Reset Control.
    $this
      ->setResetMapControl($elements, $settings);

    // Generate the Leaflet Map Position Form Element.
    $map_position_options = $settings['map_position'];
    $elements['map_position'] = $this
      ->generateMapPositionElement($map_position_options);

    // Generate the Leaflet Map weight/zIndex Form Element.
    $elements['weight'] = $this
      ->generateWeightElement($settings['weight']);

    // Generate Icon form element.
    $icon_options = $settings['icon'];
    $elements['icon'] = $this
      ->generateIconFormElement($icon_options);

    // Set Map Marker Cluster Element.
    $this
      ->setMapMarkerclusterElement($elements, $settings);

    // Set Map Geometries Options Element.
    $this
      ->setMapPathOptionsElement($elements, $settings);

    // Set Map Geocoder Control Element, if the Geocoder Module exists,
    // otherwise output a tip on Geocoder Module Integration.
    $this
      ->setGeocoderMapControl($elements, $settings);
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->t('Leaflet Map: @map', [
      '@map' => $this
        ->getSetting('leaflet_map'),
    ]);
    $summary[] = $this
      ->t('Map height: @height @height_unit', [
      '@height' => $this
        ->getSetting('height'),
      '@height_unit' => $this
        ->getSetting('height_unit'),
    ]);
    $summary[] = $this
      ->t('Popup Infowindow: @popup', [
      '@popup' => $this
        ->getSetting('popup') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($this
      ->getSetting('popup') && $this
      ->getSetting('popup_content')) {
      $summary[] = $this
        ->t('Popup content: @popup_content', [
        '@popup_content' => $this
          ->getSetting('popup_content'),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   *
   * This function is called from parent::view().
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    /* @var \Drupal\Core\Entity\EntityInterface $entity */
    $entity = $items
      ->getEntity();

    // Take the entity translation, if existing.

    /* @var \Drupal\Core\TypedData\TranslatableInterface $entity */
    if ($entity
      ->hasTranslation($langcode)) {
      $entity = $entity
        ->getTranslation($langcode);
    }
    $entity_type = $entity
      ->getEntityTypeId();
    $bundle = $entity
      ->bundle();
    $entity_id = $entity
      ->id();

    /* @var \Drupal\Core\Field\FieldDefinitionInterface $field */
    $field = $items
      ->getFieldDefinition();

    // Sets/consider possibly existing previous Zoom settings.
    $this
      ->setExistingZoomSettings();
    $settings = $this
      ->getSettings();

    // Always render the map, even if we do not have any data.
    $map = leaflet_map_get_info($settings['leaflet_map']);

    // Add a specific map id.
    $map['id'] = Html::getUniqueId("leaflet_map_{$entity_type}_{$bundle}_{$entity_id}_{$field->getName()}");

    // Get and set the Geofield cardinality.
    $map['geofield_cardinality'] = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();

    // Set Map additional map Settings.
    $this
      ->setAdditionalMapOptions($map, $settings);

    // Get token context.
    $tokens = [
      'field' => $items,
      $this->fieldDefinition
        ->getTargetEntityTypeId() => $items
        ->getEntity(),
    ];
    $results = [];
    $features = [];
    foreach ($items as $delta => $item) {
      $points = $this->leafletService
        ->leafletProcessGeofield($item->value);
      $feature = $points[0];
      $feature['entity_id'] = $entity_id;

      // Add its entity id, so that it might be referenced from outside.
      $feature['weight'] = !empty($settings['zIndex']) ? intval(str_replace([
        "\n",
        "\r",
      ], "", $this->token
        ->replace($settings['zIndex'], $tokens))) : NULL;

      // Eventually set the popup content.
      if ($settings['popup']) {

        // Construct the renderable array for popup title / text. As we later
        // convert that to plain text, losing attachments and cacheability, save
        // them to $results.
        $build = [];
        if ($this
          ->getSetting('popup_content')) {
          $bubbleable_metadata = new BubbleableMetadata();
          $popup_content = $this->token
            ->replace($this
            ->getSetting('popup_content'), $tokens, [
            'clear' => TRUE,
          ], $bubbleable_metadata);
          $build[] = [
            '#markup' => $popup_content,
          ];
          $bubbleable_metadata
            ->applyTo($results);
        }

        // We need a string for using it inside the popup. Save attachments and
        // cacheability to $results.
        $render_context = new RenderContext();
        $rendered = $this->renderer
          ->executeInRenderContext($render_context, function () use (&$build) {
          return $this->renderer
            ->render($build, TRUE);
        });
        $feature['popup'] = !empty($rendered) ? $rendered : $entity
          ->label();
        if (!$render_context
          ->isEmpty()) {
          $render_context
            ->update($results);
        }
      }

      // Add/merge eventual map icon definition from hook_leaflet_map_info.
      if (!empty($map['icon'])) {
        $settings['icon'] = $settings['icon'] ?: [];

        // Remove empty icon options so thxat they might be replaced by the
        // ones set by the hook_leaflet_map_info.
        foreach ($settings['icon'] as $k => $icon_option) {
          if (empty($icon_option) || is_array($icon_option) && $this->leafletService
            ->multipleEmpty($icon_option)) {
            unset($settings['icon'][$k]);
          }
        }
        $settings['icon'] = array_replace($map['icon'], $settings['icon']);
      }
      $icon_type = isset($settings['icon']['iconType']) ? $settings['icon']['iconType'] : 'marker';

      // Eventually set the custom Marker icon (DivIcon, Icon Url or
      // Circle Marker).
      if ($feature['type'] === 'point' && isset($settings['icon'])) {

        // Transforms Icon Options that support Replacement Patterns/Tokens.
        if (!empty($settings["icon"]["iconSize"]["x"])) {
          $settings["icon"]["iconSize"]["x"] = $this->token
            ->replace($settings["icon"]["iconSize"]["x"], $tokens);
        }
        if (!empty($settings["icon"]["iconSize"]["y"])) {
          $settings["icon"]["iconSize"]["y"] = $this->token
            ->replace($settings["icon"]["iconSize"]["y"], $tokens);
        }
        if (!empty($settings["icon"]["shadowSize"]["x"])) {
          $settings["icon"]["shadowSize"]["x"] = $this->token
            ->replace($settings["icon"]["shadowSize"]["x"], $tokens);
        }
        if (!empty($settings["icon"]["shadowSize"]["y"])) {
          $settings["icon"]["shadowSize"]["y"] = $this->token
            ->replace($settings["icon"]["shadowSize"]["y"], $tokens);
        }

        // Set Feature Icon properties.
        $feature['icon'] = $settings['icon'];
        switch ($icon_type) {
          case 'html':
            $feature['icon']['html'] = $this->token
              ->replace($settings['icon']['html'], $tokens);
            $feature['icon']['html_class'] = isset($settings['icon']['html_class']) ? $settings['icon']['html_class'] : '';
            break;
          case 'circle_marker':
            $feature['icon']['options'] = $this->token
              ->replace($settings['icon']['circle_marker_options'], $tokens);
            break;
          default:
            if (!empty($settings['icon']['iconUrl'])) {
              $feature['icon']['iconUrl'] = str_replace([
                "\n",
                "\r",
              ], "", $this->token
                ->replace($settings['icon']['iconUrl'], $tokens));
              if (!empty($feature['icon']['iconUrl'])) {

                // Generate Absolute iconUrl , if not external.
                $feature['icon']['iconUrl'] = $this->leafletService
                  ->pathToAbsolute($feature['icon']['iconUrl']);

                // Set the Feature IconSize to the IconUrl Image sizes (if empty).
              }
            }
            if (!empty($settings['icon']['shadowUrl'])) {
              $feature['icon']['shadowUrl'] = str_replace([
                "\n",
                "\r",
              ], "", $this->token
                ->replace($settings['icon']['shadowUrl'], $tokens));
              if (!empty($feature['icon']['shadowUrl'])) {

                // Generate Absolute shadowUrl, if not external.
                $feature['icon']['shadowUrl'] = $this->leafletService
                  ->pathToAbsolute($feature['icon']['shadowUrl']);
              }
            }

            // Set the Feature IconSize and ShadowSize to the IconUrl or
            // ShadowUrl Image sizes (if empty or invalid).
            $this->leafletService
              ->setFeatureIconSizesIfEmptyOrInvalid($feature);
            break;
        }
      }

      // Associate dynamic path properties (token based) to the feature,
      // in case of not point.
      if ($feature['type'] !== 'point') {
        $feature['path'] = str_replace([
          "\n",
          "\r",
        ], "", $this->token
          ->replace($settings['path'], $tokens));
      }

      // Associate dynamic className property (token based) to icon.
      $feature['className'] = !empty($settings['className']) ? str_replace([
        "\n",
        "\r",
      ], "", $this->token
        ->replace($settings['className'], $tokens)) : '';

      // Allow modules to adjust the marker.
      $this->moduleHandler
        ->alter('leaflet_formatter_feature', $feature, $item, $entity);
      $features[] = $feature;
    }

    // Order the data features based on the 'weight' element.
    uasort($data, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    $js_settings = [
      'map' => $map,
      'features' => $features,
    ];

    // Allow other modules to add/alter the map js settings.
    $this->moduleHandler
      ->alter('leaflet_default_map_formatter', $js_settings, $items);
    $map_height = !empty($settings['height']) ? $settings['height'] . $settings['height_unit'] : '';
    if (!empty($settings['multiple_map'])) {
      foreach ($js_settings['features'] as $k => $feature) {
        $map = $js_settings['map'];
        $map['id'] = $map['id'] . "-{$k}";
        $results[] = $this->leafletService
          ->leafletRenderMap($map, [
          $feature,
        ], $map_height);
      }
    }
    elseif (!empty($js_settings['features']) || empty($settings['hide_empty_map'])) {
      $results[] = $this->leafletService
        ->leafletRenderMap($js_settings['map'], $js_settings['features'], $map_height);
    }
    return $results;
  }

  /**
   * Sets possibly existing previous settings for the Zoom Form Element.
   */
  private function setExistingZoomSettings() {
    $settings = $this
      ->getSettings();
    if (isset($settings['zoom'])) {
      $settings['map_position']['zoom'] = (int) $settings['zoom'];
      $settings['map_position']['minZoom'] = (int) $settings['minZoom'];
      $settings['map_position']['maxZoom'] = (int) $settings['maxZoom'];
      $this
        ->setSettings($settings);
    }
  }

}

Classes

Name	Description
LeafletDefaultFormatter	Plugin implementation of the 'leaflet_default' formatter.