You are here

interface GeometryProviderInterface in Geocoder 8.3

Same name and namespace in other branches
  1. 8.2 modules/geocoder_geofield/src/Geocoder/Provider/GeometryProviderInterface.php \Drupal\geocoder_geofield\Geocoder\Provider\GeometryProviderInterface

Providers GeometryProvider interface..

@author William Durand <william.durand1@gmail.com> @author Tobias Nyholm <tobias.nyholm@gmail.com>

Hierarchy

Expanded class hierarchy of GeometryProviderInterface

All classes that implement GeometryProviderInterface

1 file declares its use of GeometryProviderInterface
ProviderUsingHandlerBase.php in src/ProviderUsingHandlerBase.php

File

modules/geocoder_geofield/src/Geocoder/Provider/GeometryProviderInterface.php, line 15

Namespace

Drupal\geocoder_geofield\Geocoder\Provider
View source
interface GeometryProviderInterface {

  /**
   * Geocode a source string.
   *
   * @param string $filename
   *   The file path with data to be geocoded.
   *
   * @return \Geometry
   *   The Geometry result.
   *
   * @throws \Geocoder\Exception\Exception
   */
  public function geocode($filename) : Geometry;

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

  /**
   * Returns the Geometry provider's name.
   *
   * @return string
   *   The GeometryProvider name.
   */
  public function getName() : string;

}

Members

Namesort descending Modifiers Type Description Overrides
GeometryProviderInterface::geocode public function Geocode a source string. 1
GeometryProviderInterface::getName public function Returns the Geometry provider's name. 1
GeometryProviderInterface::reverse public function Reverse ReverseGeocode. 1