interface FormatterInterface in Geocoder 8.3

Provides an interface for geocoder formatter plugins.

Formatters are plugins that can reformat address components into custom formatted string.

Hierarchy

• interface \Drupal\geocoder\Plugin\Geocoder\Formatter\FormatterInterface

1 file declares its use of FormatterInterface

FormatterPluginManager.php in src/FormatterPluginManager.php

File

src/Plugin/Geocoder/Formatter/FormatterInterface.php, line 13

Namespace

Drupal\geocoder\Plugin\Geocoder\Formatter

interface FormatterInterface {

  /**
   * Dumps the argument into a specific format.
   *
   * @param \Geocoder\Model\Address $address
   *   The address to be formatted.
   *   This (might but) is not referring to Geocoder\Location for backport
   *   compatibility with 8.x-2.x version. Third party modules might have
   *   already created their own custom formatters.
   *
   * @return string
   *   The formatted address.
   */
  public function format(Address $address);

}

Members

Name	Modifiers	Type	Description	Overrides
FormatterInterface::format	public	function	Dumps the argument into a specific format.	1