CRM_Utils_GeocodeProvider

class CRM_Utils_GeocodeProvider

Methods

static CRM_Utils_Geocode
getConfiguredProvider()

Instantiate a geocode object of the system-configured type.

static string|bool
getUsableClassName()

Get the name of the geocoding class if enabled.

static 
disableForSession()

Disable GeoProvider within a session.

static 
reset()

Reset geoprovider (after it has been disabled).

Details

at line 49
static CRM_Utils_Geocode getConfiguredProvider()

Instantiate a geocode object of the system-configured type.

Return Value

CRM_Utils_Geocode

Exceptions

CRM_Core_Exception

at line 67
static string|bool getUsableClassName()

Get the name of the geocoding class if enabled.

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 Value

string|bool Class name if usable, else false.

at line 103
static disableForSession()

Disable GeoProvider within a session.

This disables geocoding by causing getUsableClassName() to bail out.

at line 110
static reset()

Reset geoprovider (after it has been disabled).