drupal-civicrm/sites/all/modules/civicrm/api/v3/CaseContact.php
2018-01-14 13:10:16 +00:00

108 lines
3.7 KiB
PHP

<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* This api exposes CiviCRM CaseContact records.
*
* @package CiviCRM_APIv3
*/
/**
* Save a CaseContact.
*
* @param array $params
*
* @return array
*/
function civicrm_api3_case_contact_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* @param array $fields
*/
function _civicrm_api3_case_contact_create_spec(&$fields) {
$fields['contact_id']['api.required'] = $fields['case_id']['api.required'] = 1;
}
/**
* Get a CaseContact.
*
* @param array $params
*
* @return array
* Array of retrieved case_contact property values.
*/
function civicrm_api3_case_contact_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Delete a CaseContact.
*
* @param array $params
*
* @return array
* Array of deleted values.
*/
function civicrm_api3_case_contact_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
* Results formatting for Case entityRef lookups.
*
* @param array $result
* @param array $request
* @param string $entity
* @param array $fields
*
* @return array
*/
function _civicrm_api3_case_contact_getlist_output($result, $request, $entity, $fields) {
$output = array();
if (!empty($result['values'])) {
foreach ($result['values'] as $row) {
$data = array(
'id' => $row[$request['id_field']],
'label' => $row[$request['label_field']] . ' - ' . $row['case_id.case_type_id.title'],
);
$status = CRM_Core_PseudoConstant::getLabel('CRM_Case_BAO_Case', 'status_id', $row['case_id.status_id']);
$date = CRM_Utils_Date::customFormat($row['case_id.start_date']);
$data['description'] = array(
"#{$row['case_id']}: $status " . ts('(opened %1)', array(1 => $date)),
$row['case_id.subject'],
);
if (!empty($request['image_field'])) {
$data['image'] = isset($row[$request['image_field']]) ? $row[$request['image_field']] : '';
}
$output[] = $data;
}
}
return $output;
}