View source
<?php
namespace Drupal\leaflet;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\ViewsPluginInterface;
use Drupal\Core\Url;
use Drupal\Component\Serialization\Json;
trait LeafletSettingsElementsTrait {
protected $controlPositionsOptions = [
'topleft' => 'Top Left',
'topright' => 'Top Right',
'bottomleft' => 'Bottom Left',
'bottomright' => 'Bottom Right',
];
protected $leafletCircleRadiusFieldTypesOptions = [
'integer',
'float',
'decimal',
];
public static function getDefaultSettings() {
return [
'multiple_map' => FALSE,
'leaflet_map' => 'OSM Mapnik',
'height' => 400,
'height_unit' => 'px',
'hide_empty_map' => FALSE,
'disable_wheel' => FALSE,
'fullscreen_control' => TRUE,
'gesture_handling' => FALSE,
'reset_map' => [
'control' => FALSE,
'position' => 'topright',
],
'popup' => FALSE,
'popup_content' => '',
'map_position' => [
'force' => FALSE,
'center' => [
'lat' => 0,
'lon' => 0,
],
'zoom' => 12,
'minZoom' => 1,
'maxZoom' => 18,
'zoomFiner' => 0,
],
'weight' => NULL,
'icon' => [
'iconType' => 'marker',
'iconUrl' => '',
'shadowUrl' => '',
'className' => '',
'iconSize' => [
'x' => NULL,
'y' => NULL,
],
'iconAnchor' => [
'x' => NULL,
'y' => NULL,
],
'shadowSize' => [
'x' => NULL,
'y' => NULL,
],
'shadowAnchor' => [
'x' => NULL,
'y' => NULL,
],
'popupAnchor' => [
'x' => NULL,
'y' => NULL,
],
'html' => '<div></div>',
'html_class' => 'leaflet-map-divicon',
'circle_marker_options' => '{"radius": 100, "color": "red", "fillColor": "#f03", "fillOpacity": 0.5}',
],
'leaflet_markercluster' => [
'control' => FALSE,
'options' => '{"spiderfyOnMaxZoom":true,"showCoverageOnHover":true,"removeOutsideVisibleBounds": false}',
'include_path' => FALSE,
],
'path' => '{"color":"#3388ff","opacity":"1.0","stroke":true,"weight":3,"fill":"depends","fillColor":"*","fillOpacity":"0.2","radius":"6"}',
'geocoder' => [
'control' => FALSE,
'settings' => [
'position' => 'topright',
'input_size' => 25,
'providers' => [],
'min_terms' => 4,
'delay' => 800,
'zoom' => 16,
'popup' => FALSE,
'options' => '',
],
],
];
}
protected function generateMapGeneralSettings(array &$elements, array $settings) {
$leaflet_map_options = [];
foreach (leaflet_map_get_info() as $key => $map) {
$leaflet_map_options[$key] = $map['label'];
}
$leaflet_map = isset($settings['leaflet_map']) ? $settings['leaflet_map'] : $settings['map'];
$elements['leaflet_map'] = [
'#title' => $this
->t('Leaflet Map'),
'#type' => 'select',
'#options' => $leaflet_map_options,
'#default_value' => $leaflet_map,
'#required' => TRUE,
];
$elements['height'] = [
'#title' => $this
->t('Map Height'),
'#type' => 'number',
'#default_value' => $settings['height'],
'#description' => $this
->t('Note: This can be left empty to make the Map fill its parent container height.'),
];
$elements['height_unit'] = [
'#title' => t('Map height unit'),
'#type' => 'select',
'#options' => [
'px' => t('px'),
'%' => t('%'),
'vh' => t('vh'),
],
'#default_value' => $settings['height_unit'],
'#description' => t("Whether height is absolute (pixels) or relative (percent, vertical height).<br><strong>Note:</strong> In case of Percent the Leaflet Map should be wrapped in a container element with defined Height, otherwise won't show up."),
];
$elements['hide_empty_map'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Hide Map if empty'),
'#description' => $this
->t('Check this option not to render the Map at all, if empty (no output results).'),
'#default_value' => $settings['hide_empty_map'],
'#return_value' => 1,
'#states' => [
'invisible' => [
':input[name="fields[field_geofield][settings_edit_form][settings][multiple_map]"]' => [
'checked' => TRUE,
],
],
],
];
$elements['disable_wheel'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Disable zoom using mouse wheel'),
'#description' => $this
->t("If enabled, the mouse wheel won't change the zoom level of the map."),
'#default_value' => $settings['disable_wheel'],
'#return_value' => 1,
];
$elements['fullscreen_control'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Fullscreen Control'),
'#description' => $this
->t('Enable the Fullscreen View of the Map.'),
'#default_value' => $settings['fullscreen_control'],
'#return_value' => 1,
];
$elements['gesture_handling'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Gesture Handling'),
'#description' => $this
->t('Enable the @gesture_handling_link functionality for the Map.', [
'@gesture_handling_link' => $this->link
->generate($this
->t('Leaflet Gesture Handling Library'), Url::fromUri('https://github.com/elmarquis/Leaflet.GestureHandling', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
]),
'#default_value' => $settings['gesture_handling'],
'#return_value' => 1,
];
}
protected function generateMapPositionElement(array $map_position_options) {
$element = [
'#type' => 'fieldset',
'#title' => $this
->t('Starting Map State'),
];
if (isset($this->fieldDefinition)) {
$force_checkbox_selector = ':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][map_position][force]"]';
$force_checkbox_selector_widget = ':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][map][map_position][force]"]';
}
elseif ($this instanceof ViewsPluginInterface) {
$force_checkbox_selector = ':input[name="style_options[map_position][force]"]';
}
$element['description'] = [
'#type' => 'container',
'html_tag' => [
'#type' => 'html_tag',
'#tag' => 'div',
'#value' => $this
->t('These settings will be applied in case of single Marker Map (otherwise the Zoom will be set to Fit Elements bounds).'),
],
'#states' => [
'invisible' => isset($force_checkbox_selector_widget) ? [
[
$force_checkbox_selector => [
'checked' => TRUE,
],
],
'or',
[
$force_checkbox_selector_widget => [
'checked' => TRUE,
],
],
] : [
$force_checkbox_selector => [
'checked' => TRUE,
],
],
],
];
$element['force'] = [
'#type' => 'checkbox',
'#description' => $this
->t('These settings will be forced anyway as starting Map state.'),
'#default_value' => $map_position_options['force'],
'#return_value' => 1,
];
$element['#title'] = $this
->t('Custom Map Center & Zoom');
$element['description']['#value'] = $this
->t('These settings will be applied in case of empty Map.');
$element['force']['#title'] = $this
->t('Force Map Center & Zoom');
$element['center'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Map Center'),
'lat' => [
'#title' => $this
->t('Latitude'),
'#type' => 'number',
'#step' => 'any',
'#size' => 4,
'#default_value' => $map_position_options['center']['lat'] ?? $this
->getDefaultSettings()['map_position']['center']['lat'],
'#required' => FALSE,
],
'lon' => [
'#title' => $this
->t('Longitude'),
'#type' => 'number',
'#step' => 'any',
'#size' => 4,
'#default_value' => $map_position_options['center']['lon'] ?? $this
->getDefaultSettings()['map_position']['center']['lon'],
'#required' => FALSE,
],
];
$element['zoom'] = [
'#title' => $this
->t('Zoom'),
'#type' => 'number',
'#min' => 0,
'#max' => 22,
'#default_value' => $map_position_options['zoom'] ?? $this
->getDefaultSettings()['map_position']['zoom'],
'#required' => TRUE,
'#element_validate' => [
[
get_class($this),
'zoomLevelValidate',
],
],
];
if ($this instanceof ViewsPluginInterface) {
$element['zoom']['#description'] = $this
->t('These setting will be applied (anyway) to a single Marker Map.');
}
$element['minZoom'] = [
'#title' => $this
->t('Min. Zoom'),
'#type' => 'number',
'#min' => 0,
'#max' => 22,
'#default_value' => $map_position_options['minZoom'] ?? $this
->getDefaultSettings()['map_position']['minZoom'],
'#required' => TRUE,
];
$element['maxZoom'] = [
'#title' => $this
->t('Max. Zoom'),
'#type' => 'number',
'#min' => 1,
'#max' => 22,
'#default_value' => $map_position_options['maxZoom'] ?? $this
->getDefaultSettings()['map_position']['maxZoom'],
'#element_validate' => [
[
get_class($this),
'maxZoomLevelValidate',
],
],
'#required' => TRUE,
];
$element['zoomFiner'] = [
'#title' => $this
->t('Zoom Finer'),
'#type' => 'number',
'#max' => 5,
'#min' => -5,
'#step' => 1,
'#description' => $this
->t('Value that might/will be added to default Fit Elements Bounds Zoom. (-5 / +5)'),
'#default_value' => $map_position_options['zoomFiner'] ?? $this
->getDefaultSettings()['map_position']['zoomFiner'],
'#states' => [
'invisible' => isset($force_checkbox_selector_widget) ? [
[
$force_checkbox_selector => [
'checked' => TRUE,
],
],
'or',
[
$force_checkbox_selector_widget => [
'checked' => TRUE,
],
],
] : [
$force_checkbox_selector => [
'checked' => TRUE,
],
],
],
];
return $element;
}
protected function generateWeightElement($weight) {
$default_settings = $this::getDefaultSettings();
return [
'#title' => $this
->t('weight / zIndex Offset'),
'#type' => 'textfield',
'#size' => 30,
'#description' => $this
->t('This option supports <b>Replacement Patterns</b> and should end up into an Integer (positive or negative value).<br>This will apply to each Leaflet Feature/Marker result, and might be used to dynamically set its position/visibility on top (or below) of each others.'),
'#default_value' => isset($weight) ? $weight : $default_settings['weight'],
];
}
protected function generateIconFormElement(array $icon_options) {
$default_settings = $this::getDefaultSettings();
$token_replacement_disclaimer = $this
->t('<b>Note: </b> Using <strong>Replacement Patterns</strong> it is possible to dynamically define the Marker Icon output, with the composition of Marker Icon paths including entity properties or fields values.');
$icon_url_description = $this
->t('Can be an absolute or relative URL. <b>If left empty the default Leaflet Marker will be used.</b><br>@token_replacement_disclaimer', [
'@token_replacement_disclaimer' => $token_replacement_disclaimer,
]);
if (isset($this->fieldDefinition)) {
$icon_type = ':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][icon][iconType]"]';
}
else {
$icon_type = ':input[name="style_options[icon][iconType]"]';
}
$element = [
'#type' => 'fieldset',
'#title' => $this
->t('Map Icon'),
'description' => [
'#markup' => $this
->t('For details on the following setup refer to @leaflet_icon_documentation_link', [
'@leaflet_icon_documentation_link' => $this->leafletService
->leafletIconDocumentationLink(),
]),
],
];
$element['iconType'] = [
'#type' => 'radios',
'#title' => t('Icon Source'),
'#default_value' => isset($icon_options['iconType']) ? $icon_options['iconType'] : $default_settings['icon']['iconType'],
'#options' => [
'marker' => 'Icon Image Url/Path',
'html' => 'Field (html DivIcon)',
'circle_marker' => $this
->t('Circle Marker (@more_info)', [
'@more_info' => $this->link
->generate('more info', Url::fromUri('https://leafletjs.com/reference-1.6.0.html#circlemarker', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
]),
],
];
$element['iconUrl'] = [
'#title' => $this
->t('Icon URL'),
'#description' => $icon_url_description,
'#type' => 'textarea',
'#rows' => 3,
'#default_value' => isset($icon_options['iconUrl']) ? $icon_options['iconUrl'] : $default_settings['icon']['iconUrl'],
'#states' => [
'visible' => [
$icon_type => [
'value' => 'marker',
],
],
],
];
$element['shadowUrl'] = [
'#title' => $this
->t('Icon Shadow URL'),
'#description' => $icon_url_description,
'#type' => 'textarea',
'#rows' => 3,
'#default_value' => isset($icon_options['shadowUrl']) ? $icon_options['shadowUrl'] : $default_settings['icon']['shadowUrl'],
'#states' => [
'visible' => [
$icon_type => [
'value' => 'marker',
],
],
],
];
$element['className'] = [
'#title' => $this
->t('Icon Class Name'),
'#description' => $this
->t('A custom class name to assign to both icon and shadow images.<br>Supports <b>Replacement Patterns</b>'),
'#type' => 'textfield',
'#default_value' => isset($icon_options['className']) ? $icon_options['className'] : $default_settings['icon']['className'],
'#states' => [
'visible' => [
$icon_type => [
'value' => 'marker',
],
],
],
];
$element['html'] = [
'#title' => $this
->t('Html'),
'#type' => 'textarea',
'#description' => $this
->t('Insert here the Html code that will be used as marker html markup. <b>If left empty the default Leaflet Marker will be used.</b><br>@token_replacement_disclaimer', [
'@token_replacement_disclaimer' => $token_replacement_disclaimer,
]),
'#default_value' => isset($icon_options['html']) ? $icon_options['html'] : $default_settings['icon']['html'],
'#rows' => 3,
'#states' => [
'visible' => [
$icon_type => [
'value' => 'html',
],
],
'required' => [
$icon_type => [
'value' => 'html',
],
],
],
];
$element['html_class'] = [
'#type' => 'textfield',
'#title' => t('Marker HTML class'),
'#description' => t('Required class name for the div used to wrap field output. For multiple classes, separate with a space.'),
'#default_value' => isset($icon_options['html_class']) ? $icon_options['html_class'] : $default_settings['icon']['html_class'],
'#states' => [
'visible' => [
$icon_type => [
'value' => 'html',
],
],
],
];
$element['circle_marker_options'] = [
'#type' => 'textarea',
'#rows' => 2,
'#title' => $this
->t('Circle Marker Options'),
'#description' => $this
->t('An object literal of Circle Marker options, that comply with the @leaflet_circle_marker_object.<br>The syntax should respect the javascript object notation (json) format.<br>As suggested in the field placeholder, always use double quotes (") both for the indexes and the string values.<br><b>Note: </b> Use <strong>Replacement Patterns</strong> to input dynamic values.<br>Empty value will fallback to default Leaflet Circle Marker style.', [
'@leaflet_circle_marker_object' => $this->link
->generate('Leaflet Circle Marker object', Url::fromUri('https://leafletjs.com/reference-1.6.0.html#circlemarker', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
]),
'#default_value' => isset($icon_options['circle_marker_options']) ? $icon_options['circle_marker_options'] : $default_settings['icon']['circle_marker_options'],
'#placeholder' => $default_settings['icon']['circle_marker_options'],
'#element_validate' => [
[
get_class($this),
'jsonValidate',
],
],
'#states' => [
'visible' => [
$icon_type => [
'value' => 'circle_marker',
],
],
],
];
if (method_exists($this, 'getProvider') && $this
->getProvider() == 'leaflet_views') {
$twig_link = $this->link
->generate('Twig', Url::fromUri('http://twig.sensiolabs.org/documentation', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
]));
$icon_url_description .= '<br>' . $this
->t('You may include @twig_link. You may enter data from this view as per the "Replacement patterns" below.', [
'@twig_link' => $twig_link,
]);
$element['iconUrl']['#description'] = $icon_url_description;
$element['shadowUrl']['#description'] = $icon_url_description;
$options = [];
$optgroup_fields = (string) t('Fields');
if (isset($this->displayHandler)) {
foreach ($this->displayHandler
->getHandlers('field') as $id => $field) {
$options[$optgroup_fields]["{{ {$id} }}"] = substr(strrchr($field
->label(), ":"), 2);
}
}
$output = [];
if (!empty($options)) {
$output[] = [
'#markup' => '<p>' . $this
->t("The following replacement tokens are available. Fields may be marked as <em>Exclude from display</em> if you prefer.") . '</p>',
];
foreach (array_keys($options) as $type) {
if (!empty($options[$type])) {
$items = [];
foreach ($options[$type] as $key => $value) {
$items[] = $key;
}
$item_list = [
'#theme' => 'item_list',
'#items' => $items,
];
$output[] = $item_list;
}
}
}
$element['help'] = [
'#type' => 'details',
'#title' => $this
->t('Replacement patterns'),
'#value' => $output,
];
}
$element['iconSize'] = [
'#title' => $this
->t('Icon Size'),
'#type' => 'fieldset',
'#description' => $this
->t("Size of the icon image in pixels (if empty the natural icon image size will be used).<br>Both support <b>Replacement Patterns</b> and should end up into an Integer (positive value)"),
];
$element['iconSize']['x'] = [
'#title' => $this
->t('Width'),
'#type' => 'textfield',
'#size' => 30,
'#default_value' => isset($icon_options['iconSize']['x']) ? $icon_options['iconSize']['x'] : NULL,
];
$element['iconSize']['y'] = [
'#title' => $this
->t('Height'),
'#type' => 'textfield',
'#size' => 30,
'#default_value' => isset($icon_options['iconSize']['y']) ? $icon_options['iconSize']['y'] : NULL,
];
$element['iconAnchor'] = [
'#title' => $this
->t('Icon Anchor'),
'#type' => 'fieldset',
'#collapsible' => FALSE,
'#description' => $this
->t("The coordinates of the 'tip' of the icon (relative to its top left corner). The icon will be aligned so that this point is at the marker\\'s geographical location.<br>Note: Both the values shouldn't be null to be valid."),
];
$element['iconAnchor']['x'] = [
'#title' => $this
->t('X'),
'#type' => 'number',
'#min' => -1000,
'#max' => 1000,
'#default_value' => isset($icon_options['iconAnchor']) ? $icon_options['iconAnchor']['x'] : NULL,
];
$element['iconAnchor']['y'] = [
'#title' => $this
->t('Y'),
'#type' => 'number',
'#min' => -1000,
'#max' => 1000,
'#default_value' => isset($icon_options['iconAnchor']) ? $icon_options['iconAnchor']['y'] : NULL,
];
$element['shadowSize'] = [
'#title' => $this
->t('Shadow Size'),
'#type' => 'fieldset',
'#description' => $this
->t("Size of the shadow image in pixels (if empty the natural shadow image size will be used). <br>Both support <b>Replacement Patterns</b> and should end up into an Integer (positive value)"),
];
$element['shadowSize']['x'] = [
'#title' => $this
->t('Width'),
'#type' => 'textfield',
'#size' => 30,
'#default_value' => isset($icon_options['shadowSize']['x']) ? $icon_options['shadowSize']['x'] : NULL,
];
$element['shadowSize']['y'] = [
'#title' => $this
->t('Height'),
'#type' => 'textfield',
'#size' => 30,
'#default_value' => isset($icon_options['shadowSize']['y']) ? $icon_options['shadowSize']['y'] : NULL,
];
$element['shadowAnchor'] = [
'#title' => $this
->t('Shadow Anchor'),
'#type' => 'fieldset',
'#description' => $this
->t("The coordinates of the 'tip' of the shadow (relative to its top left corner) (the same as iconAnchor if not specified).<br>Note: Both the values shouldn't be null to be valid."),
];
$element['shadowAnchor']['x'] = [
'#title' => $this
->t('X'),
'#type' => 'number',
'#min' => -1000,
'#max' => 1000,
'#default_value' => isset($icon_options['shadowAnchor']) ? $icon_options['shadowAnchor']['x'] : NULL,
];
$element['shadowAnchor']['y'] = [
'#title' => $this
->t('Y'),
'#type' => 'number',
'#min' => -1000,
'#max' => 1000,
'#default_value' => isset($icon_options['shadowAnchor']) ? $icon_options['shadowAnchor']['y'] : NULL,
];
$element['popupAnchor'] = [
'#title' => $this
->t('Popup Anchor'),
'#type' => 'fieldset',
'#collapsible' => FALSE,
'#description' => $this
->t("The coordinates of the point from which popups will 'open', relative to the icon anchor.<br>Note: Both the values shouldn't be null to be valid."),
];
$element['popupAnchor']['x'] = [
'#title' => $this
->t('X'),
'#type' => 'number',
'#min' => -1000,
'#max' => 1000,
'#default_value' => isset($icon_options['popupAnchor']) ? $icon_options['popupAnchor']['x'] : NULL,
];
$element['popupAnchor']['y'] = [
'#title' => $this
->t('Y'),
'#type' => 'number',
'#min' => -1000,
'#max' => 1000,
'#default_value' => isset($icon_options['popupAnchor']) ? $icon_options['popupAnchor']['y'] : NULL,
];
return $element;
}
protected function setReplacementPatternsElement(array &$element) {
if ($this->moduleHandler
->moduleExists('token')) {
$element['replacement_patterns'] = [
'#type' => 'details',
'#title' => 'Replacement patterns',
'#description' => $this
->t('The following replacement tokens are available for the "Popup Content and the Icon Options":'),
];
$element['replacement_patterns']['token_help'] = [
'#theme' => 'token_tree_link',
'#token_types' => [
$this->fieldDefinition
->getTargetEntityTypeId(),
],
];
}
else {
$element['replacement_patterns']['#description'] = $this
->t('The @token_link is needed to browse and use @entity_type entity token replacements.', [
'@token_link' => $this->link
->generate(t('Token module'), Url::fromUri('https://www.drupal.org/project/token', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
'@entity_type' => $this->fieldDefinition
->getTargetEntityTypeId(),
]);
}
}
protected function setMapPathOptionsElement(array &$element, array $settings) {
$token_replacement_disclaimer = $this->moduleHandler
->moduleExists('token') ? $this
->t('<b>Note: </b> Using <strong>Replacement Patterns</strong> it is possible to dynamically define the Path geometries options, based on the entity properties or fields values.') : $this
->t('<b>Note: </b> Using the @token_module_link it is possible to use <strong>Replacement Patterns</strong> and dynamically define the Path geometries options, based on the entity properties or fields values.', [
'@token_module_link' => $this->link
->generate($this
->t('Toke module'), Url::fromUri('https://www.drupal.org/project/token', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
]);
$path_description = $this
->t('Set here options that will be applied to the rendering of Map Path Geometries (Lines & Polylines, Polygons, Multipolygons, etc.).<br>Refer to the @polygons_documentation.<br>Note: If empty the default Leaflet path style, or the one choosen and defined in leaflet.api/hook_leaflet_map_info, will be used.<br>@token_replacement_disclaimer', [
'@polygons_documentation' => $this->link
->generate($this
->t('Leaflet Path Documentation'), Url::fromUri('https://leafletjs.com/reference-1.0.3.html#path', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
'@token_replacement_disclaimer' => $token_replacement_disclaimer,
]);
$element['path'] = [
'#type' => 'textarea',
'#title' => $this
->t('Path Geometries Options'),
'#rows' => 3,
'#description' => $path_description,
'#default_value' => $settings['path'],
'#placeholder' => $this::getDefaultSettings()['path'],
'#element_validate' => [
[
get_class($this),
'jsonValidate',
],
],
];
}
protected function setAdditionalMapOptions(array &$map, array $options) {
$default_settings = $this::getDefaultSettings();
$map['settings']['map_position_force'] = isset($options['map_position']['force']) ? $options['map_position']['force'] : $default_settings['map_position']['force'];
$map['settings']['zoom'] = isset($options['map_position']['zoom']) ? (int) $options['map_position']['zoom'] : $default_settings['map_position']['zoom'];
$map['settings']['zoomFiner'] = isset($options['map_position']['zoomFiner']) ? (int) $options['map_position']['zoomFiner'] : $default_settings['map_position']['zoomFiner'];
$map['settings']['minZoom'] = isset($options['map_position']['minZoom']) ? (int) $options['map_position']['minZoom'] : $default_settings['map_position']['minZoom'];
$map['settings']['maxZoom'] = isset($options['map_position']['maxZoom']) ? (int) $options['map_position']['maxZoom'] : $default_settings['map_position']['maxZoom'];
$map['settings']['center'] = isset($options['map_position']['center']['lat']) && isset($options['map_position']['center']['lon']) ? [
'lat' => floatval($options['map_position']['center']['lat']),
'lon' => floatval($options['map_position']['center']['lon']),
] : $default_settings['map_position']['center'];
$map['settings']['scrollWheelZoom'] = !empty($options['disable_wheel']) ? !(bool) $options['disable_wheel'] : (isset($map['settings']['scrollWheelZoom']) ? $map['settings']['scrollWheelZoom'] : TRUE);
$map['settings']['path'] = isset($options['path']) && !empty($options['path']) ? $options['path'] : (isset($map['path']) ? Json::encode($map['path']) : Json::encode($default_settings['path']));
$map['settings']['leaflet_markercluster'] = isset($options['leaflet_markercluster']) ? $options['leaflet_markercluster'] : NULL;
$map['settings']['fullscreen_control'] = isset($options['fullscreen_control']) ? $options['fullscreen_control'] : $default_settings['fullscreen_control'];
$map['settings']['gestureHandling'] = isset($options['gesture_handling']) ? $options['gesture_handling'] : $default_settings['gesture_handling'];
$map['settings']['reset_map'] = isset($options['reset_map']) ? $options['reset_map'] : $default_settings['reset_map'];
$map['settings']['geocoder'] = isset($options['geocoder']) ? $options['geocoder'] : $default_settings['geocoder'];
}
protected function setMapMarkerclusterElement(array &$element, array $settings) {
$default_settings = $this::getDefaultSettings();
$leaflet_markercluster_submodule_warning = $this
->t("<u>Note</u>: This functionality and settings are related to the Leaflet Markercluster submodule, present inside the Leaflet module itself.<br><u>(DON'T USE the external self standing Leaflet Markecluster module).</u>");
$element['leaflet_markercluster'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Marker Clustering'),
];
if ($this->moduleHandler
->moduleExists('leaflet_markercluster')) {
$element['leaflet_markercluster']['control'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable the functionality of the @markeclusterer_api_link.', [
'@markeclusterer_api_link' => $this->link
->generate($this
->t('Leaflet Markercluster Js Library'), Url::fromUri('https://github.com/Leaflet/Leaflet.markercluster', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
]),
'#default_value' => $settings['leaflet_markercluster']['control'] ?? $default_settings['leaflet_markercluster']['control'],
'#description' => $this
->t("@leaflet_markercluster_submodule_warning", [
'@leaflet_markercluster_submodule_warning' => $leaflet_markercluster_submodule_warning,
]),
'#return_value' => 1,
];
if (isset($this->fieldDefinition)) {
$leaflet_markercluster_visibility = [
'visible' => [
':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][leaflet_markercluster][control]"]' => [
'checked' => TRUE,
],
],
];
}
else {
$leaflet_markercluster_visibility = [
'visible' => [
':input[name="style_options[leaflet_markercluster][control]"]' => [
'checked' => TRUE,
],
],
];
}
$element['leaflet_markercluster']['options'] = [
'#type' => 'textarea',
'#rows' => 4,
'#title' => $this
->t('Marker Cluster Additional Options'),
'#description' => $this
->t('An object literal of additional marker cluster options, that comply with the Leaflet Markercluster Js Library.<br>The syntax should respect the javascript object notation (json) format.<br>As suggested in the field placeholder, always use double quotes (") both for the indexes and the string values.'),
'#default_value' => $settings['leaflet_markercluster']['options'] ?? $default_settings['leaflet_markercluster']['options'],
'#placeholder' => $default_settings['leaflet_markercluster']['options'],
'#element_validate' => [
[
get_class($this),
'jsonValidate',
],
],
'#states' => $leaflet_markercluster_visibility,
];
$element['leaflet_markercluster']['include_path'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable Markeclustering of Paths elements'),
'#default_value' => $settings['leaflet_markercluster']['include_path'] ?? $default_settings['leaflet_markercluster']['include_path'],
'#description' => $this
->t("Check this options to extend Markerclustering to the Leaflet Map features extending the @path_class_link (Polygon, Polyline, Circle).", [
'@path_class_link' => $this->link
->generate($this
->t('Leaflet Path class'), Url::fromUri('https://leafletjs.com/reference-1.7.1.html#path', [
'absolute' => TRUE,
'attributes' => [
'target' => 'blank',
],
])),
]),
'#return_value' => 1,
'#states' => $leaflet_markercluster_visibility,
];
}
else {
$element['leaflet_markercluster']['markup'] = [
'#markup' => $this
->t("Enable the Leaflet Markecluster submodule to activate this functionality.<br>@leaflet_markercluster_submodule_warning", [
'@leaflet_markercluster_submodule_warning' => $leaflet_markercluster_submodule_warning,
]),
];
}
}
protected function setResetMapControl(array &$element, array $settings) {
$default_settings = $this::getDefaultSettings();
$element['reset_map'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Reset Map Control'),
];
$element['reset_map']['control'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable Map Reset Control'),
'#description' => $this
->t('This will show a "Reset Map" button to reset the Map to its initial center & zoom state<br><b><u>Warning: </u></b>Due to an issue in the Leaflet library (@see https://github.com/Leaflet/Leaflet/issues/6172) the Map Reset control doesn\'t work correctly in Fitting Bounds of coordinates having mixed positive and negative values of latitude &longitudes.<br>In this case the Map will be Reset to the default set Map Center.'),
'#default_value' => isset($settings['reset_map']['control']) ? $settings['reset_map']['control'] : $default_settings['reset_map']['control'],
];
$element['reset_map']['position'] = [
'#type' => 'select',
'#title' => $this
->t('Position'),
'#options' => $this->controlPositionsOptions,
'#default_value' => isset($settings['reset_map']['position']) ? $settings['reset_map']['position'] : $default_settings['reset_map']['position'],
];
if (isset($this->fieldDefinition)) {
$element['reset_map']['position']['#states'] = [
'visible' => [
':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][reset_map][control]"]' => [
'checked' => TRUE,
],
],
];
}
else {
$element['reset_map']['position']['#states'] = [
'visible' => [
':input[name="style_options[reset_map][control]"]' => [
'checked' => TRUE,
],
],
];
}
}
protected function setGeocoderMapControl(array &$element, array $settings) {
if ($this->moduleHandler
->moduleExists('geocoder') && class_exists('\\Drupal\\geocoder\\Controller\\GeocoderApiEnpoints')) {
$default_settings = $this::getDefaultSettings();
$element['geocoder'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Map Control - Geocoder'),
];
$element['geocoder']['control'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable Map Geocoder Control'),
'#description' => $this
->t('This will add a Geocoder control element to the Leaflet Map'),
'#default_value' => isset($settings['geocoder']['control']) ? $settings['geocoder']['control'] : $default_settings['geocoder']['control'],
];
$element['geocoder']['access_warning'] = [
'#type' => 'html_tag',
'#tag' => 'div',
'#value' => $this
->t('<strong>Note: </strong>This will show to users with permissions to <u>Access Geocoder Api Url Enpoints.</u>'),
'#attributes' => [
'style' => 'color: red;',
],
];
$element['geocoder']['settings'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Geocoder Settings'),
];
$element['geocoder']['settings']['position'] = [
'#type' => 'select',
'#title' => $this
->t('Position'),
'#options' => $this->controlPositionsOptions,
'#default_value' => isset($settings['geocoder']['settings']['position']) ? $settings['geocoder']['settings']['position'] : $default_settings['geocoder']['settings']['position'],
];
$element['geocoder']['settings']['input_size'] = [
'#title' => $this
->t('Input Size'),
'#type' => 'number',
'#min' => 10,
'#max' => 100,
'#default_value' => isset($settings['geocoder']['settings']['input_size']) ? $settings['geocoder']['settings']['input_size'] : $default_settings['geocoder']['settings']['input_size'],
'#description' => $this
->t('The characters size/length of the Geocoder Input element.'),
];
$providers_settings = isset($settings['geocoder']['settings']['providers']) ? $settings['geocoder']['settings']['providers'] : [];
$enabled_providers = [];
foreach ($providers_settings as $plugin_id => $plugin) {
if (!empty($plugin['checked'])) {
$enabled_providers[] = $plugin_id;
}
}
$geocoder_provider = \Drupal::service('plugin.manager.geocoder.provider');
$element['geocoder']['settings']['providers'] = $geocoder_provider
->providersPluginsTableList($enabled_providers);
$element['geocoder']['settings']['providers']['#element_validate'] = [
[
get_class($this),
'validateGeocoderProviders',
],
];
$element['geocoder']['settings']['min_terms'] = [
'#type' => 'number',
'#default_value' => isset($settings['geocoder']['settings']['min_terms']) ? $settings['geocoder']['settings']['min_terms'] : $default_settings['geocoder']['settings']['min_terms'],
'#title' => $this
->t('The (minimum) number of terms for the Geocoder to start processing.'),
'#description' => $this
->t('Valid values for the widget are between 2 and 10. A too low value (<= 3) will affect the application Geocode Quota usage.<br>Try to increase this value if you are experiencing Quota usage matters.'),
'#min' => 2,
'#max' => 10,
'#size' => 3,
];
$element['geocoder']['settings']['delay'] = [
'#type' => 'number',
'#default_value' => isset($settings['geocoder']['settings']['delay']) ? $settings['geocoder']['settings']['delay'] : $default_settings['geocoder']['settings']['delay'],
'#title' => $this
->t('The delay (in milliseconds) between pressing a key in the Address Input field and starting the Geocoder search.'),
'#description' => $this
->t('Valid values for the widget are multiples of 100, between 300 and 3000. A too low value (<= 300) will affect / increase the application Geocode Quota usage.<br>Try to increase this value if you are experiencing Quota usage matters.'),
'#min' => 300,
'#max' => 3000,
'#step' => 100,
'#size' => 4,
];
$element['geocoder']['settings']['zoom'] = [
'#title' => $this
->t('Zoom to Focus'),
'#type' => 'number',
'#min' => 1,
'#max' => 22,
'#default_value' => isset($settings['geocoder']['settings']['zoom']) ? $settings['geocoder']['settings']['zoom'] : $default_settings['geocoder']['settings']['zoom'],
'#description' => $this
->t('Zoom level to Focus on the Map upon the Geocoder Address selection.'),
];
$element['geocoder']['settings']['popup'] = [
'#title' => $this
->t('Open Popup on Geocode Focus'),
'#type' => 'checkbox',
'#default_value' => isset($settings['geocoder']['settings']['popup']) ? $settings['geocoder']['settings']['popup'] : $default_settings['geocoder']['settings']['popup'],
'#description' => $this
->t('Check this to open a Popup on the Map (with the found Address) upon the Geocode Focus.'),
];
$element['geocoder']['settings']['options'] = [
'#type' => 'textarea',
'#rows' => 4,
'#title' => $this
->t('Geocoder Control Specific Options'),
'#description' => $this
->t('This settings would override general Geocoder Providers options. (<u>Note: This would work only for Geocoder 2.x branch/version.</u>)<br>An object literal of specific Geocoder options.The syntax should respect the javascript object notation (json) format.<br>As suggested in the field placeholder, always use double quotes (") both for the indexes and the string values.'),
'#default_value' => isset($settings['geocoder']['settings']['options']) ? $settings['geocoder']['settings']['options'] : $default_settings['geocoder']['settings']['options'],
'#placeholder' => '{"googlemaps":{"locale": "it", "region": "it"}, "nominatim":{"locale": "it"}}',
'#element_validate' => [
[
get_class($this),
'jsonValidate',
],
],
];
if (isset($this->fieldDefinition)) {
$element['geocoder']['settings']['#states'] = [
'visible' => [
':input[name="fields[' . $this->fieldDefinition
->getName() . '][settings_edit_form][settings][geocoder][control]"]' => [
'checked' => TRUE,
],
],
];
}
else {
$element['geocoder']['settings']['#states'] = [
'visible' => [
':input[name="style_options[geocoder][control]"]' => [
'checked' => TRUE,
],
],
];
}
}
else {
$element['geocoder'] = [
'#markup' => $this
->t('<strong>Note: </strong>it is possible to enable a <u>Geocoder controller on the Leaflet Map</u> throughout the @geocoder_module_link integration (version higher than 8.x-2.3 and 8.x-3.0-alpha2).', [
'@geocoder_module_link' => $this->link
->generate('Geocoder Module', Url::fromUri('https://www.drupal.org/project/geocoder', [
'attributes' => [
'target' => 'blank',
],
])),
]),
];
}
}
public static function zoomLevelValidate($element, FormStateInterface &$form_state) {
$parents = $element['#parents'];
$values = $form_state
->getValues();
for ($i = 0; $i < count($parents) - 1; $i++) {
$values = $values[$parents[$i]];
}
$zoom = $element['#value'];
$min_zoom = $values['minZoom'];
$max_zoom = $values['maxZoom'];
if ($zoom < $min_zoom || $zoom > $max_zoom) {
$form_state
->setError($element, t('The @zoom_field should be between the Minimum and the Maximum Zoom levels.', [
'@zoom_field' => $element['#title'],
]));
}
}
public static function maxZoomLevelValidate($element, FormStateInterface &$form_state) {
$parents = $element['#parents'];
$values = $form_state
->getValues();
for ($i = 0; $i < count($parents) - 1; $i++) {
$values = $values[$parents[$i]];
}
$min_zoom = $values['minZoom'];
$max_zoom = $element['#value'];
if ($max_zoom && $max_zoom <= $min_zoom) {
$form_state
->setError($element, t('The Max Zoom level should be above the Minimum Zoom level.'));
}
}
public static function jsonValidate($element, FormStateInterface &$form_state) {
$element_values_array = Json::decode($element['#value']);
if (!empty($element['#value']) && $element_values_array == NULL) {
$form_state
->setError($element, t('The @field field is not valid Json Format.', [
'@field' => $element['#title'],
]));
}
elseif (!empty($element['#value'])) {
$form_state
->setValueForElement($element, Json::encode($element_values_array));
}
}
public static function validateGeocoderProviders(array $element, FormStateInterface &$form_state) {
$form_state_input = $form_state
->getUserInput();
if (isset($form_state_input['style_options'])) {
$geocoder_control = $form_state_input['style_options']['geocoder']['control'];
}
if (isset($form_state_input['fields'])) {
$geocoder_control = $form_state_input['fields'][$element['#array_parents'][1]]['settings_edit_form']['settings']['geocoder']['control'];
}
if (isset($geocoder_control) && $geocoder_control) {
$providers = is_array($element['#value']) ? array_filter($element['#value'], function ($value) {
return isset($value['checked']) && TRUE == $value['checked'];
}) : [];
if (empty($providers)) {
$form_state
->setError($element, t('The Geocode Origin option needs at least one geocoder plugin selected.'));
}
}
}
}
