You are here

class LeafletControlLocate in Geolocation Field 8.2

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

Provides Locate control element.

Plugin annotation


@MapFeature(
  id = "leaflet_control_locate",
  name = @Translation("Map Control - Locate"),
  description = @Translation("Add button to center on client location. Hidden on non-https connection."),
  type = "leaflet",
)

Hierarchy

Expanded class hierarchy of LeafletControlLocate

File

modules/geolocation_leaflet/src/Plugin/geolocation/MapFeature/LeafletControlLocate.php, line 15

Namespace

Drupal\geolocation_leaflet\Plugin\geolocation\MapFeature
View source
class LeafletControlLocate extends ControlCustomElementBase {

  /**
   * {@inheritdoc}
   */
  public function alterMap(array $render_array, array $feature_settings, array $context = []) {
    $render_array = parent::alterMap($render_array, $feature_settings, $context);
    $render_array['#controls'][$this
      ->getPluginId()]['control_locate'] = [
      '#type' => 'html_tag',
      '#tag' => 'a',
      '#attributes' => [
        'class' => [
          'locate',
        ],
        'href' => '#',
        'title' => $this
          ->t('Locate'),
        'role' => 'button',
      ],
    ];
    $render_array['#controls'][$this
      ->getPluginId()]['#attributes']['class'][] = 'leaflet-bar';
    return $render_array;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControlElementBase::getDefaultSettings public static function Provide a populated settings array. Overrides MapFeatureBase::getDefaultSettings
ControlElementBase::getSettingsForm public function Provide a generic map settings form array. Overrides MapFeatureBase::getSettingsForm
ControlElementBase::validateSettingsForm public function Validate Feature Form. Overrides MapFeatureBase::validateSettingsForm
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
LeafletControlLocate::alterMap public function Alter render array. Overrides ControlCustomElementBase::alterMap
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
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.