class ClientLocation in Geolocation Field 8.2
Same name in this branch
- 8.2 src/Plugin/geolocation/MapCenter/ClientLocation.php \Drupal\geolocation\Plugin\geolocation\MapCenter\ClientLocation
- 8.2 src/Plugin/geolocation/LocationInput/ClientLocation.php \Drupal\geolocation\Plugin\geolocation\LocationInput\ClientLocation
Same name and namespace in other branches
- 8.3 src/Plugin/geolocation/LocationInput/ClientLocation.php \Drupal\geolocation\Plugin\geolocation\LocationInput\ClientLocation
Location based proximity center.
Plugin annotation
@LocationInput(
id = "client_location",
name = @Translation("Client location"),
description = @Translation("If client provides location, use it."),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\geolocation\LocationInputBase implements ContainerFactoryPluginInterface, LocationInputInterface
- class \Drupal\geolocation\Plugin\geolocation\LocationInput\ClientLocation implements LocationInputInterface
- class \Drupal\geolocation\LocationInputBase implements ContainerFactoryPluginInterface, LocationInputInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ClientLocation
File
- src/
Plugin/ geolocation/ LocationInput/ ClientLocation.php, line 17
Namespace
Drupal\geolocation\Plugin\geolocation\LocationInputView source
class ClientLocation extends LocationInputBase implements LocationInputInterface {
/**
* {@inheritdoc}
*/
public static function getDefaultSettings() {
$settings = parent::getDefaultSettings();
$settings['auto_submit'] = FALSE;
$settings['hide_form'] = FALSE;
return $settings;
}
/**
* {@inheritdoc}
*/
public function getSettingsForm($option_id = NULL, array $settings = [], $context = NULL) {
$settings = $this
->getSettings($settings);
$form = parent::getSettingsForm($option_id, $settings, $context);
$form['auto_submit'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Auto-submit form'),
'#default_value' => $settings['auto_submit'],
'#description' => $this
->t('Only triggers if location could be set'),
];
$form['hide_form'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Hide coordinates form'),
'#default_value' => $settings['hide_form'],
];
$form['#description'] = $this
->t('Location will be set if it is empty and client location is available. This requires a https connection.');
return $form;
}
/**
* {@inheritdoc}
*/
public function getForm($center_option_id, array $center_option_settings, $context = NULL, array $default_value = NULL) {
$form = parent::getForm($center_option_id, $center_option_settings, $context, $default_value);
$identifier = uniqid($center_option_id);
if (!empty($form['coordinates'])) {
$form['coordinates']['#attributes'] = [
'class' => [
$identifier,
'location-input-client-location',
],
];
$form['coordinates']['#attached'] = [
'library' => [
'geolocation/location_input.client_location',
],
'drupalSettings' => [
'geolocation' => [
'locationInput' => [
'clientLocation' => [
[
'identifier' => $identifier,
'autoSubmit' => $center_option_settings['auto_submit'],
'hideForm' => $center_option_settings['hide_form'],
],
],
],
],
],
];
}
return $form;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ClientLocation:: |
public static | function |
Provide a populated settings array. Overrides LocationInputBase:: |
|
ClientLocation:: |
public | function |
Get center form. Overrides LocationInputBase:: |
|
ClientLocation:: |
public | function |
Settings form by ID and context. Overrides LocationInputBase:: |
|
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 | |
LocationInputBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
LocationInputBase:: |
public | function |
For one LocationInput (i.e. boundary filter), return all options. Overrides LocationInputInterface:: |
1 |
LocationInputBase:: |
public | function |
Get center value. Overrides LocationInputInterface:: |
2 |
LocationInputBase:: |
public | function |
Provide LocationInput option specific settings. Overrides LocationInputInterface:: |
|
LocationInputBase:: |
public | function | ||
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. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
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. |