abstract class GeocodeFormatterBase in Geocoder 8.2
Same name and namespace in other branches
- 8.3 modules/geocoder_field/src/Plugin/Field/GeocodeFormatterBase.php \Drupal\geocoder_field\Plugin\Field\GeocodeFormatterBase
Base Plugin implementation of the Geocode formatter.
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\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\geocoder_field\Plugin\Field\GeocodeFormatterBase implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of GeocodeFormatterBase
2 files declare their use of GeocodeFormatterBase
- FileGeocodeFormatter.php in modules/
geocoder_field/ src/ Plugin/ Field/ FieldFormatter/ FileGeocodeFormatter.php - GeocodeFormatter.php in modules/
geocoder_field/ src/ Plugin/ Field/ FieldFormatter/ GeocodeFormatter.php
File
- modules/
geocoder_field/ src/ Plugin/ Field/ GeocodeFormatterBase.php, line 21
Namespace
Drupal\geocoder_field\Plugin\FieldView source
abstract class GeocodeFormatterBase extends FormatterBase implements ContainerFactoryPluginInterface {
/**
* The config factory service.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $config;
/**
* The geocoder service.
*
* @var \Drupal\geocoder\ProviderPluginManager
*/
protected $geocoder;
/**
* The provider plugin manager service.
*
* @var \Drupal\geocoder\ProviderPluginManager
*/
protected $providerPluginManager;
/**
* The dumper plugin manager service.
*
* @var \Drupal\geocoder\DumperPluginManager
*/
protected $dumperPluginManager;
/**
* The Renderer service property.
*
* @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
*/
protected $renderer;
/**
* The Link generator Service.
*
* @var \Drupal\Core\Utility\LinkGeneratorInterface
*/
protected $link;
/**
* Constructs a GeocodeFormatterBase object.
*
* @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 string $label
* The formatter label display setting.
* @param string $view_mode
* The view mode.
* @param array $third_party_settings
* Any third party settings.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* A config factory for retrieving required config objects.
* @param \Drupal\geocoder\Geocoder $geocoder
* The geocoder service.
* @param \Drupal\geocoder\ProviderPluginManager $provider_plugin_manager
* The provider plugin manager service.
* @param \Drupal\geocoder\DumperPluginManager $dumper_plugin_manager
* The dumper plugin manager service.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
* @param \Drupal\Core\Utility\LinkGeneratorInterface $link_generator
* The Link Generator service.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ConfigFactoryInterface $config_factory, Geocoder $geocoder, ProviderPluginManager $provider_plugin_manager, DumperPluginManager $dumper_plugin_manager, RendererInterface $renderer, LinkGeneratorInterface $link_generator) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->config = $config_factory
->get('geocoder.settings');
$this->geocoder = $geocoder;
$this->providerPluginManager = $provider_plugin_manager;
$this->dumperPluginManager = $dumper_plugin_manager;
$this->renderer = $renderer;
$this->link = $link_generator;
}
/**
* {@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['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
->get('config.factory'), $container
->get('geocoder'), $container
->get('plugin.manager.geocoder.provider'), $container
->get('plugin.manager.geocoder.dumper'), $container
->get('renderer'), $container
->get('link_generator'));
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return parent::defaultSettings() + [
'dumper' => 'wkt',
'plugins' => [],
];
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
// Attach Geofield Map Library.
$element['#attached']['library'] = [
'geocoder/general',
];
// Get the enabled/selected plugins.
$enabled_plugins = [];
foreach ($this
->getSetting('plugins') as $plugin_id => $plugin) {
if ($plugin['checked']) {
$enabled_plugins[] = $plugin_id;
}
}
// Generates the Draggable Table of Selectable Geocoder Plugins.
$element['plugins'] = $this->providerPluginManager
->providersPluginsTableList($enabled_plugins);
// Set a validation for the plugins selection.
$element['plugins']['#element_validate'] = [
[
get_class($this),
'validatePluginsSettingsForm',
],
];
$element['dumper'] = [
'#type' => 'select',
'#weight' => 25,
'#title' => 'Output format',
'#default_value' => $this
->getSetting('dumper'),
'#options' => $this->dumperPluginManager
->getPluginsAsOptions(),
'#description' => t('Set the output format of the value. Ex, for a geofield, the format must be set to WKT.'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$provider_plugin_ids = $this
->getEnabledProviderPlugins();
$dumper_plugins = $this->dumperPluginManager
->getPluginsAsOptions();
$dumper_plugin = $this
->getSetting('dumper');
// Replace the plugin array with its name.
array_walk($provider_plugin_ids, function (&$item) {
$item = $item['name'];
});
$summary[] = t('Geocoder plugin(s): @plugin_ids', [
'@plugin_ids' => !empty($provider_plugin_ids) ? implode(', ', $provider_plugin_ids) : $this
->t('Not set'),
]);
$summary[] = t('Output format: @format', [
'@format' => !empty($dumper_plugin) ? $dumper_plugins[$dumper_plugin] : $this
->t('Not set'),
]);
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$dumper = $this->dumperPluginManager
->createInstance($this
->getSetting('dumper'));
$provider_plugins = $this
->getEnabledProviderPlugins();
foreach ($items as $delta => $item) {
if ($address_collection = $this->geocoder
->geocode($item->value, array_keys($provider_plugins))) {
$elements[$delta] = [
'#plain_text' => $dumper
->dump($address_collection
->first()),
];
}
}
return $elements;
}
/**
* Get the list of enabled Provider plugins.
*
* @return array
* Provider plugin IDs and their properties (id, name, arguments...).
*/
public function getEnabledProviderPlugins() {
$geocoder_plugins = $this->providerPluginManager
->getPlugins();
$plugins_settings = $this
->getSetting('plugins');
// Filter out unchecked plugins.
$provider_plugin_ids = array_filter($plugins_settings, function ($plugin) {
return isset($plugin['checked']) && $plugin['checked'] == TRUE;
});
$provider_plugin_ids = array_combine(array_keys($provider_plugin_ids), array_keys($provider_plugin_ids));
foreach ($geocoder_plugins as $plugin) {
if (isset($provider_plugin_ids[$plugin['id']])) {
$provider_plugin_ids[$plugin['id']] = $plugin;
}
}
return $provider_plugin_ids;
}
/**
* {@inheritdoc}
*/
public static function validatePluginsSettingsForm(array $element, FormStateInterface &$form_state) {
$plugins = array_filter($element['#value'], function ($value) {
return isset($value['checked']) && TRUE == $value['checked'];
});
if (empty($plugins)) {
$form_state
->setError($element, t('The selected Geocode operation needs at least one plugin.'));
}
}
}
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 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
GeocodeFormatterBase:: |
protected | property | The config factory service. | |
GeocodeFormatterBase:: |
protected | property | The dumper plugin manager service. | |
GeocodeFormatterBase:: |
protected | property | The geocoder service. | |
GeocodeFormatterBase:: |
protected | property | The Link generator Service. | |
GeocodeFormatterBase:: |
protected | property | The provider plugin manager service. | |
GeocodeFormatterBase:: |
protected | property | The Renderer service property. | |
GeocodeFormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
2 |
GeocodeFormatterBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
1 |
GeocodeFormatterBase:: |
public | function | Get the list of enabled Provider plugins. | |
GeocodeFormatterBase:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
2 |
GeocodeFormatterBase:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
1 |
GeocodeFormatterBase:: |
public static | function | ||
GeocodeFormatterBase:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
3 |
GeocodeFormatterBase:: |
public | function |
Constructs a GeocodeFormatterBase object. Overrides FormatterBase:: |
2 |
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. |