class ReverseGeocodeGeofieldFormatter in Geocoder 8.3

Plugin implementation of the Geocode formatter.

Plugin annotation

@FieldFormatter(
  id = "geocoder_geofield_reverse_geocode",
  label = @Translation("Reverse geocode"),
  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\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
        • class \Drupal\geocoder_field\Plugin\Field\GeocodeFormatterBase implements ContainerFactoryPluginInterface
          • class \Drupal\geocoder_field\Plugin\Field\FieldFormatter\GeocodeFormatter
            • class \Drupal\geocoder_geofield\Plugin\Field\FieldFormatter\ReverseGeocodeGeofieldFormatter

File

modules/geocoder_geofield/src/Plugin/Field/FieldFormatter/ReverseGeocodeGeofieldFormatter.php, line 21

Namespace

Drupal\geocoder_geofield\Plugin\Field\FieldFormatter

class ReverseGeocodeGeofieldFormatter extends GeocodeFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    try {
      $dumper = $this->dumperPluginManager
        ->createInstance($this
        ->getSetting('dumper'));
    } catch (PluginException $e) {
      $this->loggerFactory
        ->get('geocoder')
        ->error('No Dumper has been set');
    }
    $providers = $this
      ->getEnabledGeocoderProviders();

    /** @var \Drupal\geofield\GeoPHP\GeoPHPInterface $geophp */
    $geophp = \Drupal::service('geofield.geophp');
    foreach ($items as $delta => $item) {

      /** @var \Geometry $geom */
      $geom = $geophp
        ->load($item->value);

      /** @var \Point $centroid */
      $centroid = $geom
        ->getCentroid();
      if ($address_collection = $this->geocoder
        ->reverse($centroid
        ->y(), $centroid
        ->x(), $providers)) {
        $elements[$delta] = [
          '#markup' => $address_collection instanceof AddressCollection && !$address_collection
            ->isEmpty() ? $dumper
            ->dump($address_collection
            ->first()) : "",
        ];
      }
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
GeocodeFormatter::$incompatiblePlugins	protected	property	Geocoder Plugins not compatible with this Formatter Filed Types..
GeocodeFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides GeocodeFormatterBase::settingsForm
GeocodeFormatterBase::$dumperPluginManager	protected	property	The dumper plugin manager service.
GeocodeFormatterBase::$entityTypeManager	protected	property	The entity type manager.
GeocodeFormatterBase::$geocoder	protected	property	The geocoder service.
GeocodeFormatterBase::$geocoderProviders	protected	property	The list of created Geocoder Providers.
GeocodeFormatterBase::$link	protected	property	The Link generator Service.
GeocodeFormatterBase::$loggerFactory	protected	property	The logger factory.
GeocodeFormatterBase::$providerPluginManager	protected	property	The provider plugin manager service.
GeocodeFormatterBase::$renderer	protected	property	The Renderer service property.
GeocodeFormatterBase::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	2
GeocodeFormatterBase::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings	1
GeocodeFormatterBase::getEnabledGeocoderProviders	public	function	Returns the Geocoder providers that are enabled in this formatter.	1
GeocodeFormatterBase::getGeocoderProviders	public	function	Returns the list of created Geocoder Providers.
GeocodeFormatterBase::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary	1
GeocodeFormatterBase::validateProvidersSettingsForm	public static	function	Validates the providers selection.
GeocodeFormatterBase::__construct	public	function	Constructs a GeocodeFormatterBase object. Overrides FormatterBase::__construct	2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ReverseGeocodeGeofieldFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides GeocodeFormatterBase::viewElements
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.