}
/**
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}
}
}
- /**
+ /*
* Latitudes in all of U. S.: from -7.2 (American Samoa) to 70.5 (Alaska).
* Latitudes in continental U. S.: from 24.6 (Florida) to 49.0 (Washington).
* Average latitude of all U. S. zipcodes: 37.9.
*/
- /*
- /**
- * Estimate the Earth's radius at a given latitude.
- * Default to an approximate average radius for the United States.
- */
-
+ /**
+ * Estimate the Earth's radius at a given latitude.
+ * Default to an approximate average radius for the United States.
+ *
+ * @param float $latitude
+ * @return float
+ */
public static function earthRadius($latitude) {
$lat = deg2rad($latitude);
/**
* Convert longitude and latitude to earth-centered earth-fixed coordinates.
* X axis is 0 long, 0 lat; Y axis is 90 deg E; Z axis is north pole.
+ *
+ * @param float $longitude
+ * @param float $latitude
+ * @param float $height
+ * @return array
*/
public static function earthXYZ($longitude, $latitude, $height = 0) {
$long = deg2rad($longitude);
/**
* Convert a given angle to earth-surface distance.
+ *
+ * @param float $angle
+ * @param float $latitude
+ * @return float
*/
public static function earthArcLength($angle, $latitude) {
return deg2rad($angle) * self::earthRadius($latitude);
/**
* Estimate the min and max longitudes within $distance of a given location.
+ *
+ * @param float $longitude
+ * @param float $latitude
+ * @param float $distance
+ * @return array
*/
public static function earthLongitudeRange($longitude, $latitude, $distance) {
$long = deg2rad($longitude);
/**
* Estimate the min and max latitudes within $distance of a given location.
+ *
+ * @param float $longitude
+ * @param float $latitude
+ * @param float $distance
+ * @return array
*/
public static function earthLatitudeRange($longitude, $latitude, $distance) {
$long = deg2rad($longitude);
}
/**
- * @param $latitude
- * @param $longitude
- * @param $distance
+ * @param float $longitude
+ * @param float $latitude
+ * @param float $distance
* @param string $tablePrefix
*
* @return string
/**
* @param $query
- * @param $values
+ * @param array $values
*
* @throws Exception
*/
}
/**
- * @param $input
+ * @param array $input
*/
public static function fixInputParams(&$input) {
foreach ($input as $param) {
*/
public function __construct(&$formValues) {
$this->_formValues = $formValues;
- /**
- * Define the columns for search result rows
- */
+ // Define the columns for search result rows
$this->_columns = array(
ts('Contact ID') => 'contact_id',
ts('Name') => 'sort_name',
/**
* Define the smarty template used to layout the search form and results listings.
+ *
+ * @return string
*/
public function templateFile() {
return 'CRM/Contact/Form/Search/Custom/ContributionAggregate.tpl';
/**
* Construct the search query
+ *
+ * @param int $offset
+ * @param int $rowcount
+ * @param string|object $sort
+ * @param bool $includeContactIDs
+ * @param bool $justIDs
+ *
+ * @return string
*/
function all(
$offset = 0, $rowcount = 0, $sort = NULL,
";
}
- /*
- * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
- *
- */
/**
+ * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
+ *
* @param bool $includeContactIDs
*
* @return string
return implode(' AND ', $clauses);
}
- /*
+ /**
* Functions below generally don't need to be modified
*/
public function count() {
}
/**
- * Given the current formValues, gets the query in local
- * language
- *
- * @param array (
- * reference) $formValues submitted formValues
- *
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}
}
/**
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}
* Get the display text in plain language for the search
* to display on the results page
*
- * @return string
+ * FIXME: the current internationalisation is bad, but should more or less work
+ * on most of "European" languages
+ *
+ * @return array
+ * array of strings
*/
public function getQill() {
return NULL;
}
/**
- * FIXME: the current internationalisation is bad, but should more or less work
- * on most of "European" languages
- *
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
public function getQILL() {
return $this->_query->qill();
}
/**
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}
}
/**
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}
}
/**
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}
}
/**
- * @return array
- * which contains an array of strings
+ * @inheritDoc
*/
-
- // the current internationalisation is bad, but should more or less work
- // for most of "European" languages
public function getQILL() {
return $this->_query->qill();
}