* @throws API_Exception
* @example ContactCreate.php Example of Create Call
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
- * @static void
- * @access public
*/
function civicrm_api3_contact_create($params) {
*
* @param array input parameters
*
- * @return array API Result Array
- * (@getfields contact_get}
- * @static void
- * @access public
- *
- * @example ContactGet.php Standard GET example
- *
+ * @return array
+ * API Result Array
*/
function civicrm_api3_contact_get($params) {
$options = array();
* Delete a contact with given contact id
*
* @param array $params
- * (reference ) input parameters, contact_id element required.
- *
- * @return array API Result Array
- * @access public
+ * input parameters per getfields
*
- * @example ContactDelete.php
- * {@getfields contact_delete}
+ * @return array
+ * API Result Array
*/
function civicrm_api3_contact_delete($params) {
/**
* @param array $params
* @param bool $dupeCheck
- * @param bool $dupeErrorArray
- * @param bool $obsoletevalue
- * @param int $dedupeRuleGroupID
*
* @return null
* @throws API_Exception
* @throws CiviCRM_API3_Exception
*/
-function _civicrm_api3_contact_check_params(&$params, $dupeCheck = TRUE, $dupeErrorArray = FALSE, $obsoletevalue = TRUE, $dedupeRuleGroupID = NULL)
-{
+function _civicrm_api3_contact_check_params(&$params, $dupeCheck) {
switch (strtolower(CRM_Utils_Array::value('contact_type', $params))) {
case 'household':
$ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, $params['contact_type'], 'Unsupervised', array());
if (count($ids) > 0) {
- throw new API_Exception("Found matching contacts: " . implode(',', $ids), "duplicate", array("ids" => $ids));
+ throw new API_Exception("Found matching contacts: " . implode(',', $ids), "duplicate", array("ids" => $ids));
}
}
else {
$result = civicrm_api3('contact', 'create', array(
'organization_name' => $params['current_employer'],
- 'contact_type' => 'Organization'
+ 'contact_type' => 'Organization',
));
$params['employer_id'] = $result['id'];
}
* @param int $contactID
* If present the contact with that ID is updated.
*
- * @return CRM_Contact_BAO_Contact object
- * @access public
- * @static
+ * @return CRM_Contact_BAO_Contact|CRM_Core_Error
*/
function _civicrm_api3_contact_update($params, $contactID = NULL) {
//@todo - doesn't contact create support 'id' which is already set- check & remove
*
* @throws API_Exception
*
- * @access public
*/
function _civicrm_api3_greeting_format_params($params) {
$greetingParams = array('', '_id', '_custom');
* @deprecated
*
* {@example ContactGetquick.php 0}
- *
+ * @param array $params
+ * @return array
+ * @throws \API_Exception
*/
function civicrm_api3_contact_getquick($params) {
civicrm_api3_verify_mandatory($params, NULL, array('name'));
$contactList = array(
array(
'data' => $currEmpDetails['data'],
- 'id' => $currEmpDetails['id']
- )
+ 'id' => $currEmpDetails['id'],
+ ),
);
}
else {
$contactList = array(
array(
'data' => $name,
- 'id' => $name
- )
+ 'id' => $name,
+ ),
);
}
}
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * Array of deprecated actions
*/
function _civicrm_api3_contact_deprecation() {
return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".');
* 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.}
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
- * @static void
- * @access public
*/
function civicrm_api3_contact_merge($params) {
$mode = CRM_Utils_Array::value('mode', $params, 'safe');