class GeolocationGooglegeocoderWidget in Geolocation Field 8
Plugin implementation of the 'geolocation_googlegeocoder' widget.
Plugin annotation
@FieldWidget(
id = "geolocation_googlegeocoder",
label = @Translation("Geolocation Google Maps API - Geocoding and Map"),
field_types = {
"geolocation"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\geolocation\Plugin\Field\FieldWidget\GeolocationGooglegeocoderWidget implements ContainerFactoryPluginInterface uses GoogleMapsDisplayTrait
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of GeolocationGooglegeocoderWidget
File
- src/
Plugin/ Field/ FieldWidget/ GeolocationGooglegeocoderWidget.php, line 28
Namespace
Drupal\geolocation\Plugin\Field\FieldWidgetView source
class GeolocationGooglegeocoderWidget extends WidgetBase implements ContainerFactoryPluginInterface {
use GoogleMapsDisplayTrait;
/**
* The entity field manager.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* The GeolocationCore object.
*
* @var \Drupal\geolocation\GeolocationCore
*/
protected $geolocationCore;
/**
* Constructs a WidgetBase object.
*
* @param string $plugin_id
* The plugin_id for the widget.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The definition of the field to which the widget is associated.
* @param array $settings
* The widget settings.
* @param array $third_party_settings
* Any third party settings.
* @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
* The entity field manager.
* @param \Drupal\geolocation\GeolocationCore $geolocation_core
* The GeolocationCore object.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityFieldManagerInterface $entity_field_manager, GeolocationCore $geolocation_core) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
$this->entityFieldManager = $entity_field_manager;
$this->geolocationCore = $geolocation_core;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
->get('entity_field.manager'), $container
->get('geolocation.core'));
}
/**
* {@inheritdoc}
*/
public function flagErrors(FieldItemListInterface $items, ConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
foreach ($violations as $violation) {
if ($violation
->getMessageTemplate() == 'This value should not be null.') {
$form_state
->setErrorByName($items
->getName(), $this
->t('No location has been selected yet for required field %field.', [
'%field' => $items
->getFieldDefinition()
->getLabel(),
]));
}
}
parent::flagErrors($items, $violations, $form, $form_state);
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
$settings = [
'populate_address_field' => FALSE,
'target_address_field' => NULL,
'explicite_actions_address_field' => FALSE,
'default_longitude' => NULL,
'default_latitude' => NULL,
'auto_client_location' => FALSE,
'auto_client_location_marker' => FALSE,
'allow_override_map_settings' => FALSE,
];
$settings += parent::defaultSettings();
$settings += self::getGoogleMapDefaultSettings();
return $settings;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$settings = $this
->getSettings();
$element = [];
$element['default_longitude'] = [
'#type' => 'textfield',
'#title' => $this
->t('Default Longitude'),
'#description' => $this
->t('The default center point, before a value is set.'),
'#default_value' => $settings['default_longitude'],
];
$element['default_latitude'] = [
'#type' => 'textfield',
'#title' => $this
->t('Default Latitude'),
'#description' => $this
->t('The default center point, before a value is set.'),
'#default_value' => $settings['default_latitude'],
];
$element['auto_client_location'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Automatically use client location, when no value is set'),
'#default_value' => $settings['auto_client_location'],
];
$element['auto_client_location_marker'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Automatically set marker to client location as well'),
'#default_value' => $settings['auto_client_location_marker'],
'#states' => [
'visible' => [
':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][auto_client_location]"]' => [
'checked' => TRUE,
],
],
],
];
/** @var \Drupal\Core\Field\FieldDefinitionInterface[] $field_definitions */
$field_definitions = $this->entityFieldManager
->getFieldDefinitions($this->fieldDefinition
->getTargetEntityTypeId(), $this->fieldDefinition
->getTargetBundle());
$address_fields = [];
foreach ($field_definitions as $field_definition) {
if ($field_definition
->getType() == 'address' && $field_definition
->getFieldStorageDefinition()
->getCardinality() == 1) {
$address_fields[$field_definition
->getName()] = $field_definition
->getLabel();
}
}
if (!empty($address_fields)) {
$element['populate_address_field'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Automatically push retrieved address data to address field widget'),
'#default_value' => $settings['populate_address_field'],
];
$element['target_address_field'] = [
'#type' => 'select',
'#title' => $this
->t('Select target field to append address data.'),
'#description' => $this
->t('Only fields of type "address" with a cardinality of 1 are available.'),
'#options' => $address_fields,
'#default_value' => $settings['target_address_field'],
'#states' => [
'visible' => [
':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][populate_address_field]"]' => [
'checked' => TRUE,
],
],
],
];
$element['explicite_actions_address_field'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Use explicit push/locate buttons to interact with address field widget'),
'#default_value' => $settings['explicite_actions_address_field'],
'#states' => [
'visible' => [
':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][populate_address_field]"]' => [
'checked' => TRUE,
],
],
],
];
}
$element['allow_override_map_settings'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Allow override the map settings when create/edit an content.'),
'#default_value' => $settings['allow_override_map_settings'],
];
$element += $this
->getGoogleMapsSettingsForm($settings, 'fields][' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][');
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$settings = $this
->getSettings();
$summary[] = $this
->t('Default center longitude @default_longitude and latitude @default_latitude', [
'@default_longitude' => $settings['default_longitude'],
'@default_latitude' => $settings['default_latitude'],
]);
if (!empty($settings['auto_client_location'])) {
$summary[] = $this
->t('Will use client location automatically by default');
if (!empty($settings['auto_client_location_marker'])) {
$summary[] = $this
->t('Will set client location marker automatically by default');
}
}
if (!empty($settings['populate_address_field'])) {
$summary[] = $this
->t('Geocoded address will be stored in @field', [
'@field' => $settings['target_address_field'],
]);
}
if (!empty($settings['allow_override_map_settings'])) {
$summary[] = $this
->t('Users will be allowed to override the map settings for each content.');
}
$summary = array_merge($summary, $this
->getGoogleMapsSettingsSummary($settings));
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$settings = $this
->getGoogleMapsSettings($this
->getSettings()) + $this
->getSettings();
if (!$items
->isEmpty()) {
// Get the geolocation value for this element.
$lat = $items[$delta]->lat;
$lng = $items[$delta]->lng;
}
$default_field_values = [
'lat' => '',
'lng' => '',
];
$default_map_values = [
'lat' => $settings['default_latitude'],
'lng' => $settings['default_longitude'],
];
if (!empty($this->fieldDefinition
->getDefaultValueLiteral()[0])) {
$default_field_values = [
'lat' => $this->fieldDefinition
->getDefaultValueLiteral()[0]['lat'],
'lng' => $this->fieldDefinition
->getDefaultValueLiteral()[0]['lng'],
];
}
if (!empty($lat) && !empty($lng)) {
$default_field_values = [
'lat' => $lat,
'lng' => $lng,
];
$default_map_values = [
'lat' => $lat,
'lng' => $lng,
];
}
$canvas_id = Html::getUniqueId($this->fieldDefinition
->getName());
// Hidden lat,lng input fields.
$element['lat'] = [
'#type' => 'hidden',
'#default_value' => $default_field_values['lat'],
'#attributes' => [
'class' => [
'geolocation-hidden-lat',
],
],
];
$element['lng'] = [
'#type' => 'hidden',
'#default_value' => $default_field_values['lng'],
'#attributes' => [
'class' => [
'geolocation-hidden-lng',
],
],
];
$element['controls'] = [
'#type' => 'container',
'#attributes' => [
'id' => 'geocoder-controls-wrapper-' . $canvas_id,
'class' => [
'geocode-controls-wrapper',
],
],
];
$element['controls']['location'] = [
'#type' => 'textfield',
'#placeholder' => t('Enter a location'),
'#attributes' => [
'class' => [
'location',
'form-autocomplete',
],
],
'#theme_wrappers' => [],
];
$element['controls']['search'] = [
'#type' => 'html_tag',
'#tag' => 'button',
'#attributes' => [
'class' => [
'search',
],
'title' => t('Search'),
],
];
$element['controls']['locate'] = [
'#type' => 'html_tag',
'#tag' => 'button',
'#attributes' => [
'class' => [
'locate',
],
'style' => 'display: none;',
'title' => t('Locate'),
],
];
$element['controls']['clear'] = [
'#type' => 'html_tag',
'#tag' => 'button',
'#attributes' => [
'class' => [
'clear',
'disabled',
],
'title' => t('Clear'),
],
];
if ($settings['populate_address_field'] && $settings['explicite_actions_address_field'] && $settings['target_address_field']) {
$address_label = $this
->t('Address');
$field_definitions = $this->entityFieldManager
->getFieldDefinitions($this->fieldDefinition
->getTargetEntityTypeId(), $this->fieldDefinition
->getTargetBundle());
foreach ($field_definitions as $field_definition) {
if ($field_definition
->getName() == $settings['target_address_field']) {
$address_label = $field_definition
->getLabel();
}
}
$element['controls']['address_locate'] = [
'#type' => 'html_tag',
'#tag' => 'button',
'#attributes' => [
'class' => [
'address-button',
'address-button-locate',
],
'title' => $this
->t('Locate current %address on map', [
'%address' => $address_label,
]),
],
'#value' => $this
->t('Locate %address', [
'%address' => $address_label,
]),
];
$element['controls']['address_push'] = [
'#type' => 'html_tag',
'#tag' => 'button',
'#attributes' => [
'class' => [
'address-button',
'address-button-push',
],
'title' => $this
->t('Push current location data to %address', [
'%address' => $address_label,
]),
],
'#value' => $this
->t('Push to %address', [
'%address' => $address_label,
]),
];
}
// Add the map container.
$element['map_canvas'] = [
'#type' => 'html_tag',
'#tag' => 'div',
'#attributes' => [
'id' => $canvas_id,
'class' => [
'geolocation-map-canvas',
],
],
'#attached' => [
'library' => [
'geolocation/geolocation.widgets.googlegeocoder',
],
'drupalSettings' => [
'geolocation' => [
'widgetSettings' => [
$canvas_id => [
'autoClientLocation' => $settings['auto_client_location'] ? TRUE : FALSE,
'autoClientLocationMarker' => $settings['auto_client_location_marker'] ? TRUE : FALSE,
],
],
'widgetMaps' => [
$canvas_id => [
'lat' => (double) $default_map_values['lat'],
'lng' => (double) $default_map_values['lng'],
'settings' => $settings,
],
],
'google_map_url' => $this
->getGoogleMapsApiUrl(),
],
],
],
];
if ($settings['populate_address_field']) {
$element['map_canvas']['#attached']['drupalSettings']['geolocation']['widgetSettings'][$canvas_id]['addressFieldTarget'] = $settings['target_address_field'];
$element['map_canvas']['#attached']['drupalSettings']['geolocation']['widgetSettings'][$canvas_id]['addressFieldExpliciteActions'] = (bool) $settings['explicite_actions_address_field'];
}
if ($settings['allow_override_map_settings']) {
if (!empty($items[$delta]->data['google_map_settings'])) {
$map_settings = [
'google_map_settings' => $items[$delta]->data['google_map_settings'],
];
}
else {
$map_settings = [
'google_map_settings' => [],
];
}
$element += $this
->getGoogleMapsSettingsForm($map_settings, $this->fieldDefinition
->getName() . '][' . $delta . '][');
}
// Wrap the whole form in a container.
$element += [
'#type' => 'fieldset',
'#title' => $element['#title'],
'#attributes' => [
'class' => [
'canvas-' . $canvas_id,
],
],
];
return $element;
}
/**
* {@inheritdoc}
*/
public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
$values = parent::massageFormValues($values, $form, $form_state);
foreach ($values as $delta => $item_values) {
if (!empty($item_values['google_map_settings'])) {
$values[$delta]['data']['google_map_settings'] = $item_values['google_map_settings'];
}
// Ensure that the controls key isn't set on the values.
unset($values[$delta]['controls']);
}
return $values;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
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 | |
GeolocationGooglegeocoderWidget:: |
protected | property | The entity field manager. | |
GeolocationGooglegeocoderWidget:: |
protected | property | The GeolocationCore object. | |
GeolocationGooglegeocoderWidget:: |
public static | function |
Creates an instance of the plugin. Overrides WidgetBase:: |
|
GeolocationGooglegeocoderWidget:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
GeolocationGooglegeocoderWidget:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBase:: |
|
GeolocationGooglegeocoderWidget:: |
public | function |
Returns the form for a single field widget. Overrides WidgetInterface:: |
|
GeolocationGooglegeocoderWidget:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetBase:: |
|
GeolocationGooglegeocoderWidget:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetBase:: |
|
GeolocationGooglegeocoderWidget:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetBase:: |
|
GeolocationGooglegeocoderWidget:: |
public | function |
Constructs a WidgetBase object. Overrides WidgetBase:: |
|
GoogleMapsDisplayTrait:: |
public static | property | Google maps url with default parameters. | |
GoogleMapsDisplayTrait:: |
public static | property | Google map style - Hybrid. | |
GoogleMapsDisplayTrait:: |
public static | property | Google map max zoom level. | |
GoogleMapsDisplayTrait:: |
public static | property | Google map min zoom level. | |
GoogleMapsDisplayTrait:: |
public static | property | Google map style - Roadmap. | |
GoogleMapsDisplayTrait:: |
public static | property | Google map style - Satellite. | |
GoogleMapsDisplayTrait:: |
public static | property | Google map style - Terrain. | |
GoogleMapsDisplayTrait:: |
public static | function | Provide a populated settings array. | |
GoogleMapsDisplayTrait:: |
public | function | Return all module and custom defined parameters. | |
GoogleMapsDisplayTrait:: |
public | function | Return the fully build URL to load Google Maps API. | |
GoogleMapsDisplayTrait:: |
public | function | Provide settings ready to handover to JS to feed to Google Maps. | |
GoogleMapsDisplayTrait:: |
public | function | Provide a generic map settings form array. | |
GoogleMapsDisplayTrait:: |
public | function | Provide a summary array to use in field formatters. | |
GoogleMapsDisplayTrait:: |
private | function | An array of all available map types. | |
GoogleMapsDisplayTrait:: |
public | function | Validate the form elements defined above. | |
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. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |