CRM_Contact_BAO_ProximityQuery
in package
Tags
Table of Contents
Properties
- $_earthEccentricitySQ : float
- $_earthFlattening : float
- $_earthRadiusSemiMajor : float
- $_earthRadiusSemiMinor : float
Methods
- earthLatitudeRange() : array<string|int, mixed>
- Estimate the min and max latitudes within $distance of a given location.
- earthLongitudeRange() : array<string|int, mixed>
- Estimate the min and max longitudes within $distance of a given location.
- earthRadius() : float
- Estimate the Earth's radius at a given latitude.
- fixInputParams() : void
- initialize() : mixed
- process() : null
- Process form.
- where() : string
Properties
$_earthEccentricitySQ
protected
static float
$_earthEccentricitySQ
$_earthFlattening
protected
static float
$_earthFlattening
$_earthRadiusSemiMajor
protected
static float
$_earthRadiusSemiMajor
$_earthRadiusSemiMinor
protected
static float
$_earthRadiusSemiMinor
Methods
earthLatitudeRange()
Estimate the min and max latitudes within $distance of a given location.
public
static earthLatitudeRange(float $longitude, float $latitude, float $distance) : array<string|int, mixed>
Parameters
- $longitude : float
- $latitude : float
- $distance : float
Return values
array<string|int, mixed>earthLongitudeRange()
Estimate the min and max longitudes within $distance of a given location.
public
static earthLongitudeRange(float $longitude, float $latitude, float $distance) : array<string|int, mixed>
Parameters
- $longitude : float
- $latitude : float
- $distance : float
Return values
array<string|int, mixed>earthRadius()
Estimate the Earth's radius at a given latitude.
public
static earthRadius(float $latitude) : float
Default to an approximate average radius for the United States.
Parameters
- $latitude : float
Return values
floatfixInputParams()
public
static fixInputParams(array<string|int, mixed> &$input) : void
Parameters
- $input : array<string|int, mixed>
initialize()
public
static initialize() : mixed
process()
Process form.
public
static process(CRM_Contact_BAO_Query &$query, array<string|int, mixed> &$values) : null
Parameters
- $query : CRM_Contact_BAO_Query
- $values : array<string|int, mixed>
Tags
Return values
nullwhere()
public
static where(float $latitude, float $longitude, float $distance[, string $tablePrefix = 'civicrm_address' ]) : string
Parameters
- $latitude : float
- $longitude : float
- $distance : float
- $tablePrefix : string = 'civicrm_address'