/**
* Retrieve one or more contacts, given a set of search params
*
* @param array input parameters
*
* @return array API Result Array
* (@getfields contact_get}
* @static void
* @access public
*
* @example ContactGet.php Standard GET example
*
*/
function civicrm_api3_contact_get($params)
{
$options = array();
_civicrm_api3_contact_get_supportanomalies($params, $options);
$contacts = _civicrm_api3_get_using_query_object('contact', $params, $options);
// CRM-7929 Quick fix by colemanw
// TODO: Figure out what function is responsible for prepending 'individual_' to these keys
// and sort it out there rather than going to all this trouble here.
// Eileen's note - not sure anymore if we went the right path stripping the 'individual' here
// as is arguable whether it makes more sense now I think it would make more sense to rename the table field or uniquefield to have
// the individual prefix but we are stuck with it now for apiv3 series.
$returnContacts = array();
if (is_array($contacts)) {
foreach ($contacts as $cid => $contact) {
if (is_array($contact)) {
$returnContacts[$cid] = array();
foreach ($contact as $key => $value) {
$key = str_replace(array('individual_prefix', 'individual_suffix'), array('prefix', 'suffix'), $key);
$returnContacts[$cid][$key] = $value;
}
}
}
}
return civicrm_api3_create_success($returnContacts, $params, 'contact');
}
/**
* Get number of contacts matching the supplied criteria.
*
* @param array $params
*
* @return int
*/
function civicrm_api3_contact_getcount($params)
{
$options = array();
_civicrm_api3_contact_get_supportanomalies($params, $options);
$count = _civicrm_api3_get_using_query_object('Contact', $params, $options, 1);
return (int) $count;
}
function civicrm_api3_contact_getstat ($params) {
// mostly copy pasted from contact_get and the functions called by it
$options = array();
_civicrm_api3_contact_get_supportanomalies($params, $options);
$contacts = _civicrm_api3_get_using_query_object('contact', $params, $options);
$options = _civicrm_api3_get_options_from_params($params, TRUE);
$inputParams = CRM_Utils_Array::value('input_params', $options, array());
$returnProperties = CRM_Utils_Array::value('return', $options, array());
if(!empty($params['check_permissions'])){
// we will filter query object against getfields
$fields = civicrm_api("contact", 'getfields', array('version' => 3, 'action' => 'get'));
// we need to add this in as earlier in this function 'id' was unset in favour of $entity_id
$fields['values'][$entity . '_id'] = array();
$varsToFilter = array('returnProperties', 'inputParams');
foreach ($varsToFilter as $varToFilter){
if(!is_array($$varToFilter)){
continue;
}
$$varToFilter = array_intersect_key($$varToFilter, $fields['values']);
}
}
// $options = array_merge($options,$additional_options);
$sort = CRM_Utils_Array::value('sort', $options, NULL);
$returnSQL = CRM_Utils_Array::value('sql', $options, CRM_Utils_Array::value('options_sql', $options['input_params']));
$smartGroupCache = CRM_Utils_Array::value('smartGroupCache', $params);
$newParams = CRM_Contact_BAO_Query::convertFormValues($inputParams);
$skipPermissions = CRM_Utils_Array::value('check_permissions', $params)? 0 :1;
$query = new CRM_Contact_BAO_Query(
$params, $returnProperties,
NULL, TRUE, FALSE, 1,
$skipPermissions,
TRUE, $smartGroupCache
);
//this should add a check for view deleted if permissions are enabled
if ($skipPermissions){
$query->_skipDeleteClause = TRUE;
}
$query->generatePermissionClause(FALSE, $count);
list($select, $from, $where, $having) = $query->query($count);
$options = $query->_options;
if(!empty($query->_permissionWhereClause)){
if (empty($where)) {
$where = "WHERE $query->_permissionWhereClause";
} else {
$where = "$where AND $query->_permissionWhereClause";
}
}
$sql = "$select $from $where $having";
if (!empty($returnProperties)) {
$extra = array();
$sql = "SELECT count(*) AS total,". substr ($sql, 34,10000); //replace select contact_id, by select count(*)
$sql .= " GROUP BY ". implode (",",array_keys($returnProperties)) ;
} else {
$sql = "SELECT count(*) AS total $from $where $having";
$extra = array ("tip"=>"if you need to group by a field, use the return param, eg return=contact_type,gender",
"warning"=> "use getcount, getstat without param might be blocked in the future");
if (!empty($sort)) {
$sql .= " ORDER BY $sort ";
} else {
$sql .= " ORDER BY total DESC ";
}
}
if ($returnSQL) {
return array("is_error"=>1,"sql"=>$sql,"from"=>$from,"where"=>$where,"having"=>$having);
}
$dao = CRM_Core_DAO::executeQuery($sql);
$values = array();
while ($dao->fetch()) {
$values[] = $dao->toArray();
}
return civicrm_api3_create_success($values, $params, "contact", "getstat", $dao,$extra);
}
