You are here

public function GeocoderInterface::geocode in Geocoder 8.2

Same name and namespace in other branches
  1. 8.3 src/GeocoderInterface.php \Drupal\geocoder\GeocoderInterface::geocode()

Geocodes a string.

Parameters

string $data: The string to geocoded.

string[] $plugins: A list of plugin identifiers to use.

array $options: (optional) An associative array with plugin options, keyed plugin by the plugin id. Defaults to an empty array. These options would be merged with (and would override) plugins options set in the module configurations.

Return value

\Geocoder\Model\AddressCollection|\Geometry|null An address collection or NULL on geocoding failure.

1 method overrides GeocoderInterface::geocode()
Geocoder::geocode in src/Geocoder.php
Geocodes a string.

File

src/GeocoderInterface.php, line 25

Class

GeocoderInterface
Provides a geocoder factory method interface.

Namespace

Drupal\geocoder

Code

public function geocode($data, array $plugins, array $options = []);