You are here

Home » API reference » Geolocation Field 8.2 » GeolocationMapFormatterBase.php

abstract class GeolocationMapFormatterBase in Geolocation Field 8.2

Same name and namespace in other branches
  1. 8.3 src/Plugin/Field/FieldFormatter/GeolocationMapFormatterBase.php \Drupal\geolocation\Plugin\Field\FieldFormatter\GeolocationMapFormatterBase

Plugin base for Map based formatters.

Hierarchy

Expanded class hierarchy of GeolocationMapFormatterBase

2 files declare their use of GeolocationMapFormatterBase
GeolocationAddressFormatter.php in modules/geolocation_address/src/Plugin/Field/FieldFormatter/GeolocationAddressFormatter.php
GeolocationGeofieldMapFormatter.php in modules/geolocation_geofield/src/Plugin/Field/FieldFormatter/GeolocationGeofieldMapFormatter.php

File

src/Plugin/Field/FieldFormatter/GeolocationMapFormatterBase.php, line 17

Namespace

Drupal\geolocation\Plugin\Field\FieldFormatter
View source 
abstract class GeolocationMapFormatterBase extends FormatterBase {

  /**
   * Map Provider.
   *
   * @var \Drupal\geolocation\MapProviderInterface
   */
  protected $mapProvider = NULL;

  /**
   * Map Provider.
   *
   * @var \Drupal\geolocation\MapProviderManager
   */
  protected $mapProviderManager = NULL;

  /**
   * Data provider ID.
   *
   * @var string
   */
  protected static $dataProviderId = 'geolocation_field_provider';

  /**
   * Data Provider.
   *
   * @var \Drupal\geolocation\DataProviderInterface
   */
  protected $dataProvider = NULL;

  /**
   * MapCenter options manager.
   *
   * @var \Drupal\geolocation\MapCenterManager
   */
  protected $mapCenterManager = NULL;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $settings = $this
      ->getSettings();
    $this->mapProviderManager = \Drupal::service('plugin.manager.geolocation.mapprovider');
    $this->mapCenterManager = \Drupal::service('plugin.manager.geolocation.mapcenter');
    if (!empty($settings['map_provider_id'])) {
      $this->mapProvider = $this->mapProviderManager
        ->getMapProvider($settings['map_provider_id'], $settings['map_provider_settings']);
    }
    $this->dataProvider = \Drupal::service('plugin.manager.geolocation.dataprovider')
      ->createInstance(static::$dataProviderId, $settings['data_provider_settings']);
    if (empty($this->dataProvider)) {
      throw new \Exception('Geolocation data provider not found');
    }
    $this->dataProvider
      ->setFieldDefinition($field_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = parent::defaultSettings();
    $settings['title'] = '';
    $settings['set_marker'] = TRUE;
    $settings['common_map'] = TRUE;
    $settings['data_provider_settings'] = [];
    $settings['map_provider_id'] = '';
    if (\Drupal::moduleHandler()
      ->moduleExists('geolocation_google_maps')) {
      $settings['map_provider_id'] = 'google_maps';
    }
    elseif (\Drupal::moduleHandler()
      ->moduleExists('geolocation_leaflet')) {
      $settings['map_provider_id'] = 'leaflet';
    }
    $settings['centre'] = [
      'fit_bounds' => [
        'enable' => TRUE,
        'weight' => -101,
        'map_center_id' => 'fit_bounds',
        'settings' => [
          'reset_zoom' => TRUE,
        ],
      ],
    ];
    $settings['map_provider_settings'] = [];
    $settings['info_text'] = [
      'value' => '',
      'format' => filter_default_format(),
    ];
    $settings['use_overridden_map_settings'] = FALSE;
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $map_provider_options = $this->mapProviderManager
      ->getMapProviderOptions();
    if (empty($map_provider_options)) {
      return [
        '#type' => 'html_tag',
        '#tag' => 'span',
        '#value' => t("No map provider found."),
      ];
    }
    $settings = $this
      ->getSettings();
    $element = [];
    $data_provider_settings_form = $this->dataProvider
      ->getSettingsForm($settings['data_provider_settings'], []);
    if (!empty($data_provider_settings_form)) {
      $element['data_provider_settings'] = $data_provider_settings_form;
    }
    $element['set_marker'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Set map marker'),
      '#default_value' => $settings['set_marker'],
    ];
    $element['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Marker title'),
      '#description' => $this
        ->t('When the cursor hovers on the marker, this title will be shown as description.'),
      '#default_value' => $settings['title'],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['info_text'] = [
      '#type' => 'text_format',
      '#title' => $this
        ->t('Marker info text'),
      '#description' => $this
        ->t('When the marker is clicked, this text will be shown in a popup above it. Leave blank to not display. Token replacement supported.'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if (!empty($settings['info_text']['value'])) {
      $element['info_text']['#default_value'] = $settings['info_text']['value'];
    }
    if (!empty($settings['info_text']['format'])) {
      $element['info_text']['#format'] = $settings['info_text']['format'];
    }
    $element['replacement_patterns'] = [
      '#type' => 'details',
      '#title' => 'Replacement patterns',
      '#description' => $this
        ->t('The following replacement patterns are available.'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][set_marker]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['replacement_patterns']['token_geolocation'] = $this->dataProvider
      ->getTokenHelp();
    $cardinality = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
    if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED || $cardinality > 1) {
      $element['common_map'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Display multiple values on a common map'),
        '#description' => $this
          ->t('By default, each value will be displayed in a separate map. Settings this option displays all values on a common map instead. This settings is only useful on multi-value fields.'),
        '#default_value' => $settings['common_map'],
      ];
    }
    $element['centre'] = $this->mapCenterManager
      ->getCenterOptionsForm((array) $settings['centre'], [
      'formatter' => $this,
    ]);
    $element['map_provider_id'] = [
      '#type' => 'select',
      '#options' => $map_provider_options,
      '#title' => $this
        ->t('Map Provider'),
      '#default_value' => $settings['map_provider_id'],
      '#ajax' => [
        'callback' => [
          get_class($this->mapProviderManager),
          'addSettingsFormAjax',
        ],
        'wrapper' => 'map-provider-settings',
        'effect' => 'fade',
      ],
    ];
    $element['map_provider_settings'] = [
      '#type' => 'html_tag',
      '#tag' => 'span',
      '#value' => t("No settings available."),
    ];
    $parents = [
      'fields',
      $this->fieldDefinition
        ->getName(),
      'settings_edit_form',
      'settings',
    ];
    $map_provider_id = NestedArray::getValue($form_state
      ->getUserInput(), array_merge($parents, [
      'map_provider_id',
    ]));
    if (empty($map_provider_id)) {
      $map_provider_id = $settings['map_provider_id'];
    }
    if (empty($map_provider_id)) {
      $map_provider_id = key($map_provider_options);
    }
    $map_provider_settings = NestedArray::getValue($form_state
      ->getUserInput(), array_merge($parents, [
      'map_provider_settings',
    ]));
    if (empty($map_provider_settings)) {
      $map_provider_settings = $settings['map_provider_settings'];
    }
    if (!empty($map_provider_id)) {
      $element['map_provider_settings'] = $this->mapProviderManager
        ->createInstance($map_provider_id, $map_provider_settings)
        ->getSettingsForm($map_provider_settings, array_merge($parents, [
        'map_provider_settings',
      ]));
    }
    $element['map_provider_settings'] = array_replace($element['map_provider_settings'], [
      '#prefix' => '<div id="map-provider-settings">',
      '#suffix' => '</div>',
    ]);
    $element['use_overridden_map_settings'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use custom map settings if provided'),
      '#description' => $this
        ->t('The field map widget optionally allows to define custom map settings to use here.'),
      '#default_value' => $settings['use_overridden_map_settings'],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $summary = [];
    $summary[] = $this
      ->t('Marker set: @marker', [
      '@marker' => $settings['set_marker'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($settings['set_marker']) {
      $summary[] = $this
        ->t('Marker Title: @type', [
        '@type' => $settings['title'],
      ]);
      if (!empty($settings['info_text']['value']) && !empty($settings['info_text']['format'])) {
        $summary[] = $this
          ->t('Marker Info Text: @type', [
          '@type' => current(explode(chr(10), wordwrap(check_markup($settings['info_text']['value'], $settings['info_text']['format']), 30))),
        ]);
      }
      if (!empty($settings['common_map'])) {
        $summary[] = $this
          ->t('Common Map Display: Yes');
      }
    }
    if ($this->mapProvider) {
      $summary = array_replace_recursive($summary, $this->mapProvider
        ->getSettingsSummary($settings['map_provider_settings']));
    }
    else {
      $summary[] = $this
        ->t('Attention: No map provider set!');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    if ($items
      ->count() == 0) {
      return [];
    }
    $elements = [];
    $settings = $this
      ->getSettings();
    $locations = [];
    foreach ($items as $delta => $item) {
      $item_position = $this->dataProvider
        ->getPositionsFromItem($item);
      if (empty($item_position)) {
        continue;
      }
      $title = $this->dataProvider
        ->replaceFieldItemTokens($settings['title'], $item);
      if (empty($title)) {
        $title = $item_position['lat'] . ', ' . $item_position['lng'];
      }
      $location = [
        '#type' => 'geolocation_map_location',
        '#title' => $title,
        '#disable_marker' => empty($settings['set_marker']) ? TRUE : FALSE,
        '#position' => [
          'lat' => $item_position['lat'],
          'lng' => $item_position['lng'],
        ],
        '#weight' => $delta,
      ];
      if (!empty($settings['info_text']['value']) && !empty($settings['info_text']['format'])) {
        $location['content'] = [
          '#type' => 'processed_text',
          '#text' => $this->dataProvider
            ->replaceFieldItemTokens($settings['info_text']['value'], $item),
          '#format' => $settings['info_text']['format'],
        ];
      }
      $locations[] = $location;
    }
    $element_pattern = [
      '#type' => 'geolocation_map',
      '#settings' => $settings['map_provider_settings'],
      '#maptype' => $settings['map_provider_id'],
      '#centre' => [
        'lat' => 0,
        'lng' => 0,
      ],
      '#context' => [
        'formatter' => $this,
      ],
    ];
    if (!empty($settings['common_map'])) {
      $elements = [
        0 => $element_pattern,
      ];
      $elements[0]['#id'] = uniqid("map-");
      foreach ($locations as $delta => $location) {
        $elements[0][$delta] = $location;
      }
      $elements[0] = $this->mapCenterManager
        ->alterMap($elements[0], $settings['centre'], [
        'formatter' => $this,
      ]);
    }
    else {
      foreach ($locations as $delta => $location) {
        $elements[$delta] = $element_pattern;
        $elements[$delta]['#id'] = uniqid("map-" . $delta . "-");
        $elements[$delta]['content'] = $location;
        $elements[$delta] = $this->mapCenterManager
          ->alterMap($elements[$delta], $settings['centre'], [
          'formatter' => $this,
        ]);
      }
    }
    if ($settings['use_overridden_map_settings'] && !empty($items
      ->get(0)) && !empty($items
      ->get(0)
      ->getValue()['data']['map_provider_settings']) && is_array($items
      ->get(0)
      ->getValue()['data']['map_provider_settings'])) {
      $map_settings = $this->mapProvider
        ->getSettings($items
        ->get(0)
        ->getValue()['data']['map_provider_settings']);
      if (!empty($settings['common_map'])) {
        $elements[0]['#settings'] = $map_settings;
      }
      else {
        foreach (Element::children($elements) as $delta => $element) {
          $elements[$delta]['#settings'] = $map_settings;
        }
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    $settings = $this
      ->getSettings();
    if (!empty($settings['info_text'])) {
      $filter_format = FilterFormat::load($settings['info_text']['format']);
    }
    if (!empty($filter_format)) {
      $dependencies['config'][] = $filter_format
        ->getConfigDependencyName();
    }
    return $dependencies;
  }

}

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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
GeolocationMapFormatterBase::$dataProvider protected property Data Provider.
GeolocationMapFormatterBase::$dataProviderId protected static property Data provider ID. 3
GeolocationMapFormatterBase::$mapCenterManager protected property MapCenter options manager.
GeolocationMapFormatterBase::$mapProvider protected property Map Provider.
GeolocationMapFormatterBase::$mapProviderManager protected property Map Provider.
GeolocationMapFormatterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
GeolocationMapFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
GeolocationMapFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
GeolocationMapFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
GeolocationMapFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
GeolocationMapFormatterBase::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.