X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FContact.php;h=c9dc42d61a2256f0e8ff69bd76a022c6e609e06b;hb=af3775b322b9e4f11d097067367f0ea7763f5f10;hp=5d97e5362a4ee3f06a12f9c08de1eedf341a7999;hpb=dc64d047267e30477353bbd8ade2cc5c862ef122;p=civicrm-core.git diff --git a/api/v3/Contact.php b/api/v3/Contact.php index 5d97e5362a..c9dc42d61a 100644 --- a/api/v3/Contact.php +++ b/api/v3/Contact.php @@ -26,18 +26,19 @@ */ /** - * new version of civicrm apis. See blog post at - * http://civicrm.org/node/131 - * @todo Write sth + * This api exposes CiviCRM contacts. + * + * Contacts are the main entity in CiviCRM and this api is more robust than most. + * - Get action allows all params supported by advanced search. + * - Create action allows creating several related entities at once (e.g. email). + * - Create allows checking for duplicate contacts. + * Use getfields to list the full range of parameters and options supported by each action. * * @package CiviCRM_APIv3 - * @subpackage API_Contact - * @copyright CiviCRM LLC (c) 2004-2014 - * $Id: Contact.php 30879 2010-11-22 15:45:55Z shot $ */ /** - * Create or update a contact (note you should always call this via civicrm_api() & never directly). + * Create or update a Contact. * * @param array $params * Input parameters. @@ -113,7 +114,7 @@ function civicrm_api3_contact_create($params) { * Adjust Metadata for Create action. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_contact_create_spec(&$params) { $params['contact_type']['api.required'] = 1; @@ -142,12 +143,12 @@ function _civicrm_api3_contact_create_spec(&$params) { 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); - return civicrm_api3_create_success($contacts, $params, 'contact'); + $contacts = _civicrm_api3_get_using_query_object('Contact', $params, $options); + return civicrm_api3_create_success($contacts, $params, 'Contact'); } /** - * Get count of contact. + * Get number of contacts matching the supplied criteria. * * @param array $params * @@ -156,7 +157,7 @@ function civicrm_api3_contact_get($params) { 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); + $count = _civicrm_api3_get_using_query_object('Contact', $params, $options, 1); return (int) $count; } @@ -164,7 +165,7 @@ function civicrm_api3_contact_getcount($params) { * Adjust Metadata for Get action. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_contact_get_spec(&$params) { $params['contact_is_deleted']['api.default'] = 0; @@ -211,7 +212,7 @@ function _civicrm_api3_contact_get_spec(&$params) { /** * Support for historical oddities. * - * We are supporting 'showAll' = 'all', 'trash' or 'active' for contact get + * We are supporting 'showAll' = 'all', 'trash' or 'active' for Contact get * and for getcount * - hopefully some day we'll come up with a std syntax for the 3-way-boolean of * 0, 1 or not set @@ -256,7 +257,7 @@ function _civicrm_api3_contact_get_supportanomalies(&$params, &$options) { } /** - * Delete a contact with given contact id. + * Delete a Contact with given contact_id. * * @param array $params * input parameters per getfields @@ -379,7 +380,7 @@ function _civicrm_api3_contact_check_params(&$params, $dupeCheck) { $params['employer_id'] = $dupeIds[0]; } else { - $result = civicrm_api3('contact', 'create', array( + $result = civicrm_api3('Contact', 'create', array( 'organization_name' => $params['current_employer'], 'contact_type' => 'Organization', )); @@ -391,7 +392,7 @@ function _civicrm_api3_contact_check_params(&$params, $dupeCheck) { } /** - * Helper function for contact create. + * Helper function for Contact create. * * @param array $params * (reference ) an assoc array of name/value pairs. @@ -535,7 +536,7 @@ function _civicrm_api3_greeting_format_params($params) { } /** - * Old contact quick search api. + * Old Contact quick search api. * * @deprecated * @@ -686,7 +687,7 @@ function civicrm_api3_contact_getquick($params) { $where .= " AND cc.contact_type LIKE '{$contactType}'"; } - //set default for current_employer or return contact with particular id + // Set default for current_employer or return contact with particular id if (!empty($params['id'])) { $where .= " AND cc.id = " . (int) $params['id']; } @@ -695,7 +696,7 @@ function civicrm_api3_contact_getquick($params) { $where .= " AND cc.id <> " . (int) $params['cid']; } - //contact's based of relationhip type + // Contact's based of relationhip type $relType = NULL; if (!empty($params['rel'])) { $relation = explode('_', CRM_Utils_Array::value('rel', $params)); @@ -833,7 +834,7 @@ LIMIT 0, {$limit} } } - return civicrm_api3_create_success($contactList, $params, 'contact', 'getquick'); + return civicrm_api3_create_success($contactList, $params, 'Contact', 'getquick'); } /** @@ -851,14 +852,11 @@ function _civicrm_api3_contact_deprecation() { * Merges given pair of duplicate contacts. * * @param array $params - * Input parameters. - * - * Allowed @params array keys are: - * {int main_id main contact id with whom merge has to happen} - * {int other_id duplicate contact which would be deleted after merge operation} - * {string mode helps decide how to behave when there are conflicts. - * A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.} - * {boolean auto_flip wether to let api decide which contact to retain and which to delete.} + * Allowed array keys are: + * -int main_id: main contact id with whom merge has to happen + * -int other_id: duplicate contact which would be deleted after merge operation + * -string mode: "safe" skips the merge if there are no conflicts. Does a force merge otherwise. + * -boolean auto_flip: whether to let api decide which contact to retain and which to delete. * * @return array * API Result Array @@ -944,7 +942,7 @@ WHERE $whereClause $contacts[] = $dao->toArray(); } - return civicrm_api3_create_success($contacts, $params, 'contact', 'get_by_location', $dao); + return civicrm_api3_create_success($contacts, $params, 'Contact', 'get_by_location', $dao); }