class LeafletWidget in Leaflet Widget for Geofield 8.2
Same name and namespace in other branches
- 8 src/Plugin/Field/FieldWidget/LeafletWidget.php \Drupal\leaflet_widget\Plugin\Field\FieldWidget\LeafletWidget
Plugin implementation of the "leaflet_widget" widget.
Plugin annotation
@FieldWidget(
id = "leaflet_widget",
label = @Translation("Leaflet Map"),
description = @Translation("Provides a map powered by Leaflet and Leaflet.widget."),
field_types = {
"geofield",
},
)
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\geofield\Plugin\Field\FieldWidget\GeofieldBaseWidget implements ContainerFactoryPluginInterface
- class \Drupal\geofield\Plugin\Field\FieldWidget\GeofieldDefaultWidget
- class \Drupal\leaflet_widget\Plugin\Field\FieldWidget\LeafletWidget uses LeafletWidgetSettingsTrait
- class \Drupal\geofield\Plugin\Field\FieldWidget\GeofieldDefaultWidget
- class \Drupal\geofield\Plugin\Field\FieldWidget\GeofieldBaseWidget implements ContainerFactoryPluginInterface
- 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 LeafletWidget
File
- src/
Plugin/ Field/ FieldWidget/ LeafletWidget.php, line 27
Namespace
Drupal\leaflet_widget\Plugin\Field\FieldWidgetView source
class LeafletWidget extends GeofieldDefaultWidget {
use LeafletWidgetSettingsTrait;
/**
* The geoPhpWrapper service.
*
* @var \Drupal\leaflet\LeafletService
*/
protected $leafletService;
/**
* LeafletWidget constructor.
*
* @param string $plugin_id
* The plugin_id for the formatter.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The definition of the field to which the formatter is associated.
* @param array $settings
* The formatter settings.
* @param array $third_party_settings
* Any third party settings settings.
* @param \Drupal\geofield\GeoPHP\GeoPHPInterface $geophp_wrapper
* The geoPhpWrapper.
* @param \Drupal\geofield\WktGeneratorInterface $wkt_generator
* The WKT format Generator service.
* @param \Drupal\leaflet\LeafletService $leaflet_service
* The Leaflet service.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, GeoPHPInterface $geophp_wrapper, WktGeneratorInterface $wkt_generator, LeafletService $leaflet_service) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings, $geophp_wrapper, $wkt_generator);
$this->leafletService = $leaflet_service;
}
/**
* {@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('geofield.geophp'), $container
->get('geofield.wkt_generator'), $container
->get('leaflet.service'));
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
parent::settingsForm($form, $form_state);
$form = $this
->getWidgetSettingsForm($form);
return $form;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
// Attach class to wkt input element, so we can find it in js/widget.js.
$json_element_name = 'leaflet-widget-input';
$element['value']['#attributes']['class'][] = $json_element_name;
// Determine map settings and add map element.
$map_settings = $this
->getSetting('map');
$input_settings = $this
->getSetting('input');
$js_settings = [];
$map = leaflet_map_get_info($map_settings['leaflet_map']);
$map['settings']['center'] = $map_settings['center'];
$map['settings']['zoom'] = $map_settings['zoom'];
if (!empty($map_settings['locate'])) {
$js_settings['locate'] = TRUE;
unset($map['settings']['center']);
}
$element['map'] = $this->leafletService
->leafletRenderMap($map, [], $map_settings['height'] . 'px');
$element['map']['#weight'] = -1;
$element['title']['#type'] = 'item';
$element['title']['#title'] = $element['value']['#title'];
$element['title']['#weight'] = -2;
$element['value']['#title'] = $this
->t('GeoJson Data');
// Build JS settings for leaflet widget.
$js_settings['map_id'] = $element['map']['#map_id'];
$js_settings['jsonElement'] = '.' . $json_element_name;
$cardinality = $items
->getFieldDefinition()
->getFieldStorageDefinition()
->getCardinality();
$js_settings['multiple'] = $cardinality == 1 ? FALSE : TRUE;
$js_settings['cardinality'] = $cardinality > 0 ? $cardinality : 0;
$js_settings['autoCenter'] = $map_settings['auto_center'];
$js_settings['inputHidden'] = empty($input_settings['show']);
$js_settings['inputReadonly'] = !empty($input_settings['readonly']);
$js_settings['toolbarSettings'] = !empty($this
->getSetting('toolbar')) ? $this
->getSetting('toolbar') : [];
$js_settings['scrollZoomEnabled'] = !empty($map_settings['scroll_zoom_enabled']) ? $map_settings['scroll_zoom_enabled'] : FALSE;
// Include javascript.
$element['map']['#attached']['library'][] = 'leaflet_widget/widget';
// Leaflet.draw plugin.
$element['map']['#attached']['library'][] = 'leaflet_widget/leaflet-geoman';
// Settings and geo-data are passed to the widget keyed by field id.
$element['map']['#attached']['drupalSettings']['leaflet_widget'] = [
$element['map']['#map_id'] => $js_settings,
];
// Convert default value to geoJSON format.
if ($geom = $this->geoPhpWrapper
->load($element['value']['#default_value'])) {
$element['value']['#default_value'] = $geom
->out('json');
}
return $element;
}
public function getFieldDefinition() {
return $this->fieldDefinition;
}
}
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 | |
GeofieldBaseWidget:: |
protected | property | The Geofield Backend setup for the specific Field definition. | |
GeofieldBaseWidget:: |
protected | property | The geoPhpWrapper service. | |
GeofieldBaseWidget:: |
protected | property | The WKT format Generator service. | |
GeofieldBaseWidget:: |
protected | function | Return the specific Geofield Backend Value. | |
GeofieldDefaultWidget:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetBase:: |
|
GeofieldDefaultWidget:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetBase:: |
|
GeofieldDefaultWidget:: |
public static | function | ||
LeafletWidget:: |
protected | property | The geoPhpWrapper service. | |
LeafletWidget:: |
public static | function |
Creates an instance of the plugin. Overrides GeofieldBaseWidget:: |
|
LeafletWidget:: |
public | function |
Returns the form for a single field widget. Overrides GeofieldDefaultWidget:: |
|
LeafletWidget:: |
public | function | ||
LeafletWidget:: |
public | function |
Returns a form to configure settings for the widget. Overrides GeofieldDefaultWidget:: |
|
LeafletWidget:: |
public | function |
LeafletWidget constructor. Overrides GeofieldBaseWidget:: |
|
LeafletWidgetSettingsTrait:: |
public static | function | ||
LeafletWidgetSettingsTrait:: |
protected static | function | Get maps available for use with Leaflet. | |
LeafletWidgetSettingsTrait:: |
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. | |
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 |
Reports field-level validation errors against actual form elements. 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:: |