CRM_Utils_GeocodeProvider
in package
Tags
Table of Contents
Properties
- $providerClassName : string|bool
- Caches the provider class name. Disables geocoding when set to FALSE.
Methods
- disableForSession() : mixed
- Disable GeoProvider within a session.
- getConfiguredProvider() : CRM_Utils_Geocode
- Instantiate a geocode object of the system-configured type.
- getUsableClassName() : string|bool
- Get the name of the geocoding class if enabled.
- reset() : mixed
- Reset geoprovider (after settting has been changed).
Properties
$providerClassName
Caches the provider class name. Disables geocoding when set to FALSE.
private
static string|bool
$providerClassName
Methods
disableForSession()
Disable GeoProvider within a session.
public
static disableForSession() : mixed
This disables geocoding by causing getUsableClassName() to bail out.
getConfiguredProvider()
Instantiate a geocode object of the system-configured type.
public
static getConfiguredProvider() : CRM_Utils_Geocode
Tags
Return values
CRM_Utils_GeocodegetUsableClassName()
Get the name of the geocoding class if enabled.
public
static getUsableClassName() : string|bool
This retrieves the geocoding class, checking it can be accessed. Checks are done to mitigate the possibility it has been configured and then the file has been removed.
Return values
string|bool —Class name if usable, else false.
reset()
Reset geoprovider (after settting has been changed).
public
static reset() : mixed