abstract class GeocoderBase in Geolocation Field 8.3
Same name and namespace in other branches
- 8 src/GeocoderBase.php \Drupal\geolocation\GeocoderBase
- 8.2 src/GeocoderBase.php \Drupal\geolocation\GeocoderBase
Class GeocoderBase.
@package Drupal\geolocation
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\geolocation\GeocoderBase implements ContainerFactoryPluginInterface, GeocoderInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of GeocoderBase
6 files declare their use of GeocoderBase
- Dummy.php in tests/
modules/ geolocation_dummy_geocoder/ src/ Plugin/ geolocation/ Geocoder/ Dummy.php - Geocodio.php in modules/
geolocation_geocodio/ src/ Plugin/ geolocation/ Geocoder/ Geocodio.php - GoogleGeocoderBase.php in modules/
geolocation_google_maps/ src/ GoogleGeocoderBase.php - Nominatim.php in modules/
geolocation_leaflet/ src/ Plugin/ geolocation/ Geocoder/ Nominatim.php - Photon.php in modules/
geolocation_leaflet/ src/ Plugin/ geolocation/ Geocoder/ Photon.php
File
- src/
GeocoderBase.php, line 14
Namespace
Drupal\geolocationView source
abstract class GeocoderBase extends PluginBase implements GeocoderInterface, ContainerFactoryPluginInterface {
/**
* Country formatter manager.
*
* @var \Drupal\geolocation\GeocoderCountryFormattingManager
*/
protected $countryFormatterManager;
/**
* GoogleGeocoderBase constructor.
*
* @param array $configuration
* Configuration.
* @param string $plugin_id
* Plugin ID.
* @param mixed $plugin_definition
* Plugin definition.
* @param \Drupal\geolocation\GeocoderCountryFormattingManager $geocoder_country_formatter_manager
* Country formatter manager.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, GeocoderCountryFormattingManager $geocoder_country_formatter_manager) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->countryFormatterManager = $geocoder_country_formatter_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('plugin.manager.geolocation.geocoder_country_formatting'));
}
/**
* Return plugin default settings.
*
* @return array
* Default settings.
*/
protected function getDefaultSettings() {
return [
'label' => $this
->t('Address'),
'description' => $this
->t('Enter an address to be localized.'),
];
}
/**
* Return plugin settings.
*
* @return array
* Settings.
*/
public function getSettings() {
return array_replace_recursive($this
->getDefaultSettings(), $this->configuration);
}
/**
* {@inheritdoc}
*/
public function getOptionsForm() {
$settings = $this
->getSettings();
return [
'label' => [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#default_value' => $settings['label'],
'#size' => 15,
],
'description' => [
'#type' => 'textfield',
'#title' => $this
->t('Description'),
'#default_value' => $settings['description'],
'#size' => 25,
],
];
}
/**
* {@inheritdoc}
*/
public function processOptionsForm(array $form_element) {
return NULL;
}
/**
* {@inheritdoc}
*/
public function formAttachGeocoder(array &$render_array, $element_name) {
$settings = $this
->getSettings();
$render_array['geolocation_geocoder_address'] = [
'#type' => 'search',
'#title' => $settings['label'] ?: $this
->t('Address'),
'#placeholder' => $settings['label'] ?: $this
->t('Address'),
'#description' => $settings['description'] ?: $this
->t('Enter an address to retrieve location.'),
'#description_display' => 'after',
'#maxlength' => 256,
'#size' => 25,
'#attributes' => [
'class' => [
'geolocation-geocoder-address',
'form-autocomplete',
],
'data-source-identifier' => $element_name,
],
'#attached' => [
'drupalSettings' => [
'geolocation' => [
'geocoder' => [
$this
->getPluginId() => [
'inputIds' => [
$element_name => $element_name,
],
],
],
],
],
],
];
}
/**
* Get formatted address elements from atomics.
*
* @param array $address_atomics
* Address Atomics.
*
* @return array
* Address Elements
*/
protected function addressElements(array $address_atomics) {
$formatter = $this->countryFormatterManager
->getCountry($address_atomics['countryCode'], $this
->getPluginId());
if (empty($formatter)) {
return $address_atomics;
}
return $formatter
->format($address_atomics);
}
/**
* {@inheritdoc}
*/
public function geocode($address) {
return NULL;
}
/**
* {@inheritdoc}
*/
public function reverseGeocode($latitude, $longitude) {
return NULL;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
GeocoderBase:: |
protected | property | Country formatter manager. | |
GeocoderBase:: |
protected | function | Get formatted address elements from atomics. | |
GeocoderBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
1 |
GeocoderBase:: |
public | function |
Attach geocoding logic to input element. Overrides GeocoderInterface:: |
4 |
GeocoderBase:: |
public | function |
Geocode an address. Overrides GeocoderInterface:: |
7 |
GeocoderBase:: |
protected | function | Return plugin default settings. | 2 |
GeocoderBase:: |
public | function |
Return additional options form. Overrides GeocoderInterface:: |
2 |
GeocoderBase:: |
public | function | Return plugin settings. | |
GeocoderBase:: |
public | function |
Process the form built above. Overrides GeocoderInterface:: |
|
GeocoderBase:: |
public | function |
Reverse geocode an address. Overrides GeocoderInterface:: |
3 |
GeocoderBase:: |
public | function |
GoogleGeocoderBase constructor. Overrides PluginBase:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |