abstract class GeoPhpGeocodeFormatter in Geocoder 8.3
Same name and namespace in other branches
- 8.2 modules/geocoder_geofield/src/Plugin/Field/FieldFormatter/GeoPhpGeocodeFormatter.php \Drupal\geocoder_geofield\Plugin\Field\FieldFormatter\GeoPhpGeocodeFormatter
Abstract implementation of the GeoPhp Wrapper formatter for File fields.
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\geocoder_field\Plugin\Field\FieldFormatter\FileGeocodeFormatter
- class \Drupal\geocoder_geofield\Plugin\Field\FieldFormatter\GeoPhpGeocodeFormatter
- class \Drupal\geocoder_field\Plugin\Field\FieldFormatter\FileGeocodeFormatter
- 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 GeoPhpGeocodeFormatter
File
- modules/
geocoder_geofield/ src/ Plugin/ Field/ FieldFormatter/ GeoPhpGeocodeFormatter.php, line 23
Namespace
Drupal\geocoder_geofield\Plugin\Field\FieldFormatterView source
abstract class GeoPhpGeocodeFormatter extends FileGeocodeFormatter {
/**
* Unique Geocoder Plugin used by this formatter.
*
* @var string
*/
protected $formatterPlugin = '';
/**
* The geoPhpWrapper service.
*
* @var \Drupal\geofield\GeoPHP\GeoPHPInterface
*/
protected $geoPhpWrapper;
/**
* Constructs a GeoPhpGeocodeFormatter 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\geocoder\GeocoderInterface $geocoder
* The gecoder 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.
* @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
* The logger factory.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\geocoder_field\PreprocessorPluginManager $preprocessor_manager
* The Preprocessor Manager.
* @param \Drupal\geofield\GeoPHP\GeoPHPInterface $geophp_wrapper
* The geoPhpWrapper.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, GeocoderInterface $geocoder, ProviderPluginManager $provider_plugin_manager, DumperPluginManager $dumper_plugin_manager, RendererInterface $renderer, LinkGeneratorInterface $link_generator, LoggerChannelFactoryInterface $logger_factory, EntityTypeManagerInterface $entity_type_manager, PreprocessorPluginManager $preprocessor_manager, GeoPHPInterface $geophp_wrapper) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $geocoder, $provider_plugin_manager, $dumper_plugin_manager, $renderer, $link_generator, $logger_factory, $entity_type_manager, $preprocessor_manager);
$this->geoPhpWrapper = $geophp_wrapper;
}
/**
* {@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('geocoder'), $container
->get('plugin.manager.geocoder.provider'), $container
->get('plugin.manager.geocoder.dumper'), $container
->get('renderer'), $container
->get('link_generator'), $container
->get('logger.factory'), $container
->get('entity_type.manager'), $container
->get('plugin.manager.geocoder.preprocessor'), $container
->get('geofield.geophp'));
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return parent::defaultSettings() + [
'adapter' => 'wkt',
];
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
$element['adapter'] = [
'#type' => 'select',
'#title' => 'Output format',
'#options' => $this->geoPhpWrapper
->getAdapterMap(),
'#default_value' => $this
->getSetting('adapter'),
];
unset($element['dumper']);
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$adapters = $this->geoPhpWrapper
->getAdapterMap();
$adapter = $this
->getSetting('adapter');
$summary['intro'] = $this->pluginDefinition['description'];
$summary += parent::settingsSummary();
unset($summary['dumper']);
$summary['adapter'] = t('Output format: @format', [
'@format' => !empty($adapter) ? $adapters[$adapter] : $this
->t('Not set'),
]);
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$adapters = $this->geoPhpWrapper
->getAdapterMap();
$adapter = $this
->getSetting('adapter');
try {
/* @var \Drupal\geocoder_field\PreprocessorInterface $preprocessor */
$preprocessor = $this->preprocessorManager
->createInstance('file');
$preprocessor
->setField($items)
->preprocess();
$providers = $this
->getEnabledGeocoderProviders();
if (array_key_exists($adapter, $adapters)) {
foreach ($items as $delta => $item) {
/* @var \Geometry $collection */
if ($collection = $this->geocoder
->geocode($item->value, $providers)) {
$elements[$delta] = [
'#markup' => $collection
->out($adapter),
];
}
}
}
} catch (\Exception $e) {
watchdog_exception('geocoder', $e);
}
return $elements;
}
}
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 | |
FileGeocodeFormatter:: |
protected | property | The Preprocessor Manager. | |
FileGeocodeFormatter:: |
public | function |
Returns the Geocoder providers that are enabled in this formatter. Overrides GeocodeFormatterBase:: |
|
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 dumper plugin manager service. | |
GeocodeFormatterBase:: |
protected | property | The entity type manager. | |
GeocodeFormatterBase:: |
protected | property | The geocoder service. | |
GeocodeFormatterBase:: |
protected | property | The list of created Geocoder Providers. | |
GeocodeFormatterBase:: |
protected | property | The Link generator Service. | |
GeocodeFormatterBase:: |
protected | property | The logger factory. | |
GeocodeFormatterBase:: |
protected | property | The provider plugin manager service. | |
GeocodeFormatterBase:: |
protected | property | The Renderer service property. | |
GeocodeFormatterBase:: |
public | function | Returns the list of created Geocoder Providers. | |
GeocodeFormatterBase:: |
public static | function | Validates the providers selection. | |
GeoPhpGeocodeFormatter:: |
protected | property |
Unique Geocoder Plugin used by this formatter. Overrides FileGeocodeFormatter:: |
3 |
GeoPhpGeocodeFormatter:: |
protected | property | The geoPhpWrapper service. | |
GeoPhpGeocodeFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FileGeocodeFormatter:: |
|
GeoPhpGeocodeFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides GeocodeFormatterBase:: |
|
GeoPhpGeocodeFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FileGeocodeFormatter:: |
|
GeoPhpGeocodeFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FileGeocodeFormatter:: |
|
GeoPhpGeocodeFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides FileGeocodeFormatter:: |
|
GeoPhpGeocodeFormatter:: |
public | function |
Constructs a GeoPhpGeocodeFormatter object. Overrides FileGeocodeFormatter:: |
|
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. |