You are here

class LeafletTileLayer in Geolocation Field 8.2

Same name and namespace in other branches
  1. 8.3 modules/geolocation_leaflet/src/Plugin/geolocation/MapFeature/LeafletTileLayer.php \Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature\LeafletTileLayer

Provides map tile layer support.

Plugin annotation


@MapFeature(
  id = "leaflet_tile_layer",
  name = @Translation("Tile Layer - Providers"),
  description = @Translation("Select a map tile layer."),
  type = "leaflet",
)

Hierarchy

Expanded class hierarchy of LeafletTileLayer

File

modules/geolocation_leaflet/src/Plugin/geolocation/MapFeature/LeafletTileLayer.php, line 19

Namespace

Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature
View source
class LeafletTileLayer extends MapFeatureBase {
  use LeafletTileLayerProviders;

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'tile_layer_provider' => 'OpenStreetMap.Mapnik',
      'tile_provider_options' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm(array $settings, array $parents) {
    $form = parent::getSettingsForm($settings, $parents);
    if ($parents) {
      $first = array_shift($parents);
      $parents_string = $first . '[' . implode('][', $parents);
    }
    else {
      $parents_string = NULL;
    }
    $settings = $this
      ->getSettings($settings);
    $providers = $this
      ->getBaseMaps();
    $form['tile_layer_provider'] = [
      '#type' => 'select',
      '#options' => $providers,
      '#default_value' => $settings['tile_layer_provider'],
    ];
    $form['tile_provider_options'] = $this
      ->getProviderOptionsForm($settings['tile_provider_options']);
    foreach ($this->register as $provider) {
      $states = [];
      foreach ($providers[$provider] as $key => $variant) {
        $states[][':input[name="' . $parents_string . '][tile_layer_provider]"]'] = [
          'value' => $key,
        ];
      }
      foreach ($form['tile_provider_options'][$provider] as $key => $value) {
        $form['tile_provider_options'][$provider][$key]['#states']['visible'] = $states;
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $render_array, array $feature_settings, array $context = []) {
    $render_array = parent::alterMap($render_array, $feature_settings, $context);
    $feature_settings = $this
      ->getSettings($feature_settings);
    $tileLayer = [
      'enable' => TRUE,
      'tileLayerProvider' => str_replace(' ', '.', $feature_settings['tile_layer_provider']),
    ];
    $provider = explode('.', $feature_settings['tile_layer_provider'])[0];
    if (isset($feature_settings['tile_provider_options'][$provider])) {
      $tileLayer['tileLayerOptions'] = $feature_settings['tile_provider_options'][$provider];
    }
    $render_array['#attached'] = BubbleableMetadata::mergeAttachments(empty($render_array['#attached']) ? [] : $render_array['#attached'], [
      'library' => [
        'geolocation_leaflet/mapfeature.' . $this
          ->getPluginId(),
      ],
      'drupalSettings' => [
        'geolocation' => [
          'maps' => [
            $render_array['#id'] => [
              $this
                ->getPluginId() => $tileLayer,
            ],
          ],
        ],
      ],
    ]);
    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
LeafletTileLayer::alterMap public function Alter render array. Overrides MapFeatureBase::alterMap
LeafletTileLayer::getDefaultSettings public static function Provide a populated settings array. Overrides MapFeatureBase::getDefaultSettings
LeafletTileLayer::getSettingsForm public function Provide a generic map settings form array. Overrides MapFeatureBase::getSettingsForm
LeafletTileLayerProviders::$register protected property List of providers that need registration.
LeafletTileLayerProviders::getBaseMaps protected function Provide some available tile providers.
LeafletTileLayerProviders::getProviderOptionsForm protected function Provide a form with the provider options.
MapFeatureBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
MapFeatureBase::getSettings public function Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface::getSettings
MapFeatureBase::getSettingsSummary public function Provide a summary array to use in field formatters. Overrides MapFeatureInterface::getSettingsSummary 1
MapFeatureBase::validateSettingsForm public function Validate Feature Form. Overrides MapFeatureInterface::validateSettingsForm 5
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
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.