PHP Interface League\Geotools\Batch\BatchInterface

Author: Antoine Corcy ([email protected])
Datei anzeigen Open project: toin0u/geotools

Public Methods

Method Description
geocode ( string | array $values ) : League\Geotools\Batch\BatchInterface Set an array of closures to geocode.
parallel ( ) : AddressCollection[] Returns an array of AddressCollection processed in parallel.
reverse ( League\Geotools\Coordinate\CoordinateInterface | array $coordinates ) : League\Geotools\Batch\BatchInterface Set an array of closures to reverse geocode.
serie ( ) : AddressCollection[] Returns an array of AddressCollection processed in serie.
setCache ( League\Geotools\Cache\CacheInterface $cache ) : League\Geotools\Batch\BatchInterface Set the cache object to use.

Method Details

geocode() public method

If a provider throws an exception it will return an empty AddressCollection.
public geocode ( string | array $values ) : League\Geotools\Batch\BatchInterface
$values string | array A value or an array of values to geocode.
return League\Geotools\Batch\BatchInterface

parallel() public method

Returns an array of AddressCollection processed in parallel.
public parallel ( ) : AddressCollection[]
return AddressCollection[]

reverse() public method

If a provider throws an exception it will return an empty AddressCollection.
public reverse ( League\Geotools\Coordinate\CoordinateInterface | array $coordinates ) : League\Geotools\Batch\BatchInterface
$coordinates League\Geotools\Coordinate\CoordinateInterface | array A coordinate or an array of coordinates to reverse.
return League\Geotools\Batch\BatchInterface

serie() public method

Returns an array of AddressCollection processed in serie.
public serie ( ) : AddressCollection[]
return AddressCollection[]

setCache() public method

Set the cache object to use.
public setCache ( League\Geotools\Cache\CacheInterface $cache ) : League\Geotools\Batch\BatchInterface
$cache League\Geotools\Cache\CacheInterface The cache object to use.
return League\Geotools\Batch\BatchInterface