interface ProviderInterface in Geocoder 8.2

Provides an interface for geocoder provider plugins.

Providers are plugins that knows how to parse an input, passed as string, and transform it into geographical data.

Hierarchy

• interface \Drupal\geocoder\ProviderInterface

File

src/ProviderInterface.php, line 11

Namespace

Drupal\geocoder

interface ProviderInterface {

  /**
   * Geocode a source string.
   *
   * @param string $source
   *   The data to be geocoded.
   *
   * @return \Geocoder\Model\AddressCollection|\Geometry|null
   *   The address object or NULL.
   */
  public function geocode($source);

  /**
   * Reverse geocode latitude and longitude.
   *
   * @param float $latitude
   *   The latitude.
   * @param float $longitude
   *   The longitude.
   *
   * @return \Geocoder\Model\AddressCollection|null
   *   The AddressCollection object, NULL otherwise.
   */
  public function reverse($latitude, $longitude);

}

Members

Name	Modifiers	Type	Description	Overrides
ProviderInterface::geocode	public	function	Geocode a source string.	1
ProviderInterface::reverse	public	function	Reverse geocode latitude and longitude.	1