class MarkerClusterer in Geolocation Field 8.2
Same name and namespace in other branches
- 8.3 modules/geolocation_google_maps/src/Plugin/geolocation/MapFeature/MarkerClusterer.php \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\MarkerClusterer
Provides marker clusterer.
Plugin annotation
@MapFeature(
id = "marker_clusterer",
name = @Translation("Marker Clusterer"),
description = @Translation("Group elements on the map."),
type = "google_maps",
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
- class \Drupal\geolocation_google_maps\Plugin\geolocation\MapFeature\MarkerClusterer
- class \Drupal\geolocation\MapFeatureBase implements ContainerFactoryPluginInterface, MapFeatureInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of MarkerClusterer
File
- modules/
geolocation_google_maps/ src/ Plugin/ geolocation/ MapFeature/ MarkerClusterer.php, line 20
Namespace
Drupal\geolocation_google_maps\Plugin\geolocation\MapFeatureView source
class MarkerClusterer extends MapFeatureBase {
/**
* {@inheritdoc}
*/
public static function getDefaultSettings() {
return [
'image_path' => '',
'styles' => [],
'max_zoom' => 15,
'zoom_on_click' => TRUE,
'average_center' => FALSE,
'grid_size' => 60,
'minimum_cluster_size' => 2,
];
}
/**
* {@inheritdoc}
*/
public function getSettingsForm(array $settings, array $parents) {
$settings = $this
->getSettings($settings);
$form['description'] = [
'#type' => 'html_tag',
'#tag' => 'span',
'#value' => $this
->t('Various <a href=":url">examples</a> are available.', [
':url' => 'https://developers.google.com/maps/documentation/javascript/marker-clustering',
]),
];
$form['image_path'] = [
'#title' => $this
->t('Cluster image path'),
'#type' => 'textfield',
'#default_value' => $settings['image_path'],
'#description' => $this
->t("Set the marker image path. If omitted, the default image path %url will be used.", [
'%url' => 'https://developers.google.com/maps/documentation/javascript/examples/markerclusterer/m',
]),
];
$form['styles'] = [
'#title' => $this
->t('Styles of the Cluster'),
'#type' => 'textarea',
'#default_value' => $settings['styles'],
'#description' => $this
->t('Set custom Cluster styles in JSON Format. Custom Styles have to be set for all 5 Cluster Images. See the <a href=":reference">reference</a> for details.', [
':reference' => 'https://googlemaps.github.io/js-marker-clusterer/docs/reference.html',
]),
];
$form['zoom_on_click'] = [
'#title' => $this
->t('Zoom on click'),
'#type' => 'checkbox',
'#description' => $this
->t('Whether clicking zooms in on a cluster.'),
'#default_value' => $settings['zoom_on_click'],
];
$form['average_center'] = [
'#title' => $this
->t('Average center'),
'#type' => 'checkbox',
'#description' => $this
->t('Whether the center of each cluster should be the average of all markers in the cluster.'),
'#default_value' => $settings['average_center'],
];
$form['grid_size'] = [
'#type' => 'textfield',
'#title' => $this
->t('Grid size'),
'#description' => $this
->t('Set the grid size for clustering.'),
'#size' => 4,
'#default_value' => $settings['grid_size'],
];
$form['minimum_cluster_size'] = [
'#type' => 'textfield',
'#title' => $this
->t('Minimum cluster size'),
'#description' => $this
->t('Set the minimum size for a cluster of markers.'),
'#size' => 4,
'#default_value' => $settings['minimum_cluster_size'],
];
$form['max_zoom'] = [
'#title' => $this
->t('Max Zoom'),
'#type' => 'number',
'#min' => GoogleMaps::$MINZOOMLEVEL,
'#max' => GoogleMaps::$MAXZOOMLEVEL,
'#default_value' => $settings['max_zoom'],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function validateSettingsForm(array $values, FormStateInterface $form_state, array $parents) {
$marker_clusterer_styles = $values['styles'];
if (!empty($marker_clusterer_styles)) {
$style_parents = $parents;
$style_parents[] = 'styles';
if (!is_string($marker_clusterer_styles)) {
$form_state
->setErrorByName(implode('][', $style_parents), $this
->t('Please enter a JSON string as style.'));
}
$json_result = json_decode($marker_clusterer_styles);
if ($json_result === NULL) {
$form_state
->setErrorByName(implode('][', $style_parents), $this
->t('Decoding style JSON failed. Error: %error.', [
'%error' => json_last_error(),
]));
}
elseif (!is_array($json_result)) {
$form_state
->setErrorByName(implode('][', $style_parents), $this
->t('Decoded style JSON is not an array.'));
}
}
if (!is_numeric($values['grid_size'])) {
$form_state
->setErrorByName(implode('][', $parents) . '][grid_size', $this
->t('Grid size must be a number.'));
}
if (!is_numeric($values['minimum_cluster_size'])) {
$form_state
->setErrorByName(implode('][', $parents) . '][minimum_cluster_size', $this
->t('Minimum cluster size must be a number.'));
}
}
/**
* {@inheritdoc}
*/
public function alterMap(array $render_array, array $feature_settings, array $context = []) {
$render_array = parent::alterMap($render_array, $feature_settings, $context);
$feature_settings = $this
->getSettings($feature_settings);
if (!empty($feature_settings['styles']) && is_string($feature_settings['styles'])) {
$feature_settings['styles'] = json_decode($feature_settings['styles']);
}
$render_array['#attached'] = BubbleableMetadata::mergeAttachments(empty($render_array['#attached']) ? [] : $render_array['#attached'], [
'library' => [
'geolocation_google_maps/mapfeature.' . $this
->getPluginId(),
],
'drupalSettings' => [
'geolocation' => [
'maps' => [
$render_array['#id'] => [
$this
->getPluginId() => [
'enable' => TRUE,
'imagePath' => $feature_settings['image_path'],
'styles' => $feature_settings['styles'],
'maxZoom' => (int) $feature_settings['max_zoom'],
'gridSize' => (int) $feature_settings['grid_size'],
'zoomOnClick' => (bool) $feature_settings['zoom_on_click'],
'averageCenter' => (int) $feature_settings['average_center'],
'minimumClusterSize' => (int) $feature_settings['minimum_cluster_size'],
],
],
],
],
],
]);
return $render_array;
}
}
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 | |
MapFeatureBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
MapFeatureBase:: |
public | function |
Provide map feature specific settings ready to handover to JS. Overrides MapFeatureInterface:: |
|
MapFeatureBase:: |
public | function |
Provide a summary array to use in field formatters. Overrides MapFeatureInterface:: |
1 |
MarkerClusterer:: |
public | function |
Alter render array. Overrides MapFeatureBase:: |
|
MarkerClusterer:: |
public static | function |
Provide a populated settings array. Overrides MapFeatureBase:: |
|
MarkerClusterer:: |
public | function |
Provide a generic map settings form array. Overrides MapFeatureBase:: |
|
MarkerClusterer:: |
public | function |
Validate Feature Form. Overrides MapFeatureBase:: |
|
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. |