/**
* Open a new case, add client and manager roles, and add standard timeline
*
- * @param array (
+ * @param array (
* //REQUIRED:
* 'case_type_id' => int OR
* 'case_type' => str (provide one or the other)
* 'details' => str // html format
*
* @throws API_Exception
- * @return array api result array
+ * @return array
+ * api result array
*
* @access public
* {@getfields case_create}
/**
* Adjust Metadata for Get Action
*
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_case_get_spec(&$params) {
$params['contact_id']['api.aliases'] = array('client_id');
/**
* Adjust Metadata for Create Action
*
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_case_create_spec(&$params) {
$params['contact_id']['api.aliases'] = array('client_id');
/**
* Adjust Metadata for Update action
*
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_case_update_spec(&$params) {
$params['id']['api.required'] = 1;
/**
* Adjust Metadata for Delete action
*
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
function _civicrm_api3_case_delete_spec(&$params) {
$params['id']['api.required'] = 1;
* {@getfields case_get}
*
* @throws API_Exception
- * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found@access public
+ * @return array
+ * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
+ * @access public
* @todo Erik Hommel 16 dec 2010 check if all DB fields are returned
*/
function civicrm_api3_case_get($params) {
$options['return'] = array('contacts' => 1, 'activities' => 1);
}
- $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case');
+ $foundcases = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Case');
$cases = array();
foreach ($foundcases['values'] as $foundcase) {
- if ($case = _civicrm_api3_case_read($foundcase['id'], $options)) {
- $cases[$foundcase['id']] = $case;
- }
+ if ($case = _civicrm_api3_case_read($foundcase['id'], $options)) {
+ $cases[$foundcase['id']] = $case;
}
+ }
return civicrm_api3_create_success($cases, $params, 'case', 'get');
}
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * of deprecated actions
*/
function _civicrm_api3_case_deprecation() {
return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
/**
* Update a specified case.
*
- * @param array (
+ * @param array (
* //REQUIRED:
* 'case_id' => int
*
* 'contact_id' => int // case client
*
* @throws API_Exception
- * @return array api result array
+ * @return array
+ * api result array
*
* @access public
*/
/**
* Delete a specified case.
*
- * @param array (
+ * @param array (
* //REQUIRED:
* 'id' => int
*
* 'move_to_trash' => bool (defaults to false)
*
* @throws API_Exception
- * @return boolean: true if success, else false
+ * @return boolean
+ * true if success, else false
* {@getfields case_delete}
* @access public
*/
*
* @param $options
*
- * @return array case object
+ * @return array
+ * case object
*/
function _civicrm_api3_case_read($caseId, $options) {
$return = CRM_Utils_Array::value('return', $options, array());