class LatLonFormatter in Geofield 8

Plugin implementation of the 'geofield_latlon' formatter.

Plugin annotation


@FieldFormatter(
  id = "geofield_latlon",
  label = @Translation("Lat/Lon"),
  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\geofield\Plugin\Field\FieldFormatter\GeofieldDefaultFormatter implements ContainerFactoryPluginInterface
    class \Drupal\geofield\Plugin\Field\FieldFormatter\LatLonFormatter

Expanded class hierarchy of LatLonFormatter

File

src/Plugin/Field/FieldFormatter/LatLonFormatter.php, line 20

Namespace

Drupal\geofield\Plugin\Field\FieldFormatter

View source

class LatLonFormatter extends GeofieldDefaultFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'output_format' => 'decimal',
    ];
  }

  /**
   * Helper function to get the formatter settings options.
   *
   * @return array
   *   The formatter settings options.
   */
  protected function formatOptions() {
    return [
      'decimal' => $this
        ->t("Decimal Format (17.76972)"),
      'dms' => $this
        ->t("DMS Format (17° 46' 11'' N)"),
      'dm' => $this
        ->t("DM Format (17° 46.19214' N)"),
      'wkt' => $this
        ->t("WKT"),
    ];
  }

  /**
   * Returns the output format, set or default one.
   *
   * @return string
   *   The output format string.
   */
  protected function getOutputFormat() {
    return in_array($this
      ->getSetting('output_format'), array_keys($this
      ->formatOptions())) ? $this
      ->getSetting('output_format') : self::defaultSettings()['output_format'];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    unset($elements['output_escape']);
    $elements['output_format'] = [
      '#title' => $this
        ->t('Output Format'),
      '#type' => 'select',
      '#default_value' => $this
        ->getOutputFormat(),
      '#options' => $this
        ->formatOptions(),
      '#required' => TRUE,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary[] = $this
      ->t('Geospatial output format: @format', [
      '@format' => $this
        ->formatOptions()[$this
        ->getOutputFormat()],
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $output = [
        '#markup' => '',
      ];
      $geom = $this->geoPhpWrapper
        ->load($item->value);
      if ($geom) {

        // If the geometry is not a point, get the centroid.
        if ($geom
          ->getGeomType() != 'Point') {
          $geom = $geom
            ->centroid();
        }

        /* @var \Point $geom */
        if ($this
          ->getOutputFormat() == 'decimal') {
          $output = [
            '#theme' => 'geofield_latlon',
            '#lat' => $geom
              ->y(),
            '#lon' => $geom
              ->x(),
          ];
        }
        elseif ($this
          ->getOutputFormat() == 'wkt') {
          $output = [
            '#markup' => "POINT ({$geom->x()} {$geom->y()})",
          ];
        }
        else {
          $components = $this
            ->getDmsComponents($geom);
          $output = [
            '#theme' => 'geofield_dms',
            '#components' => $components,
          ];
        }
      }
      $elements[$delta] = $output;
    }
    return $elements;
  }

  /**
   * Generates the DMS expected components given a Point.
   *
   * @param \Point $point
   *   The point to represent as DMS.
   *
   * @return array
   *   The DMS LatLon components
   */
  protected function getDmsComponents(\Point $point) {
    $dms_point = DmsConverter::decimalToDms($point
      ->x(), $point
      ->y());
    $components = [];
    foreach ([
      'lat',
      'lon',
    ] as $component) {
      $item = $dms_point
        ->get($component);
      if ($this
        ->getSetting('output_format') == 'dm') {
        $item['minutes'] = number_format($item['minutes'] + $item['seconds'] / 60, 5);
        $item['seconds'] = NULL;
      }
      $components[$component] = $item;
    }
    return $components;
  }

}

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
GeofieldDefaultFormatter::$geoPhpWrapper	protected	property	The geoPhpWrapper service.
GeofieldDefaultFormatter::$options	protected	property	The Adapter Map Options.
GeofieldDefaultFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
GeofieldDefaultFormatter::__construct	public	function	GeofieldDefaultFormatter constructor. Overrides FormatterBase::__construct
LatLonFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides GeofieldDefaultFormatter::defaultSettings
LatLonFormatter::formatOptions	protected	function	Helper function to get the formatter settings options.
LatLonFormatter::getDmsComponents	protected	function	Generates the DMS expected components given a Point.
LatLonFormatter::getOutputFormat	protected	function	Returns the output format, set or default one. Overrides GeofieldDefaultFormatter::getOutputFormat
LatLonFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides GeofieldDefaultFormatter::settingsForm
LatLonFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides GeofieldDefaultFormatter::settingsSummary
LatLonFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides GeofieldDefaultFormatter::viewElements
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
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.

You are here

class LatLonFormatter in Geofield 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation