3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Case.
31 * @package CiviCRM_APIv3
35 * Create or update case type.
37 * @param array $params
40 * @throws API_Exception
44 function civicrm_api3_case_type_create($params) {
45 civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__
));
46 // Computed properties.
47 unset($params['is_forkable']);
48 unset($params['is_forked']);
50 if (!array_key_exists('is_active', $params) && empty($params['id'])) {
51 $params['is_active'] = TRUE;
53 // This is an existing case-type.
54 if (!empty($params['id']) && isset($params['definition'])
55 && !CRM_Case_BAO_CaseType
::isForked($params['id']) // which is not yet forked
56 && !CRM_Case_BAO_CaseType
::isForkable($params['id']) // for which new forks are prohibited
58 unset($params['definition']);
60 $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'CaseType');
61 return _civicrm_api3_case_type_get_formatResult($result);
65 * Retrieve case types.
67 * @param array $params
70 * case types keyed by id
72 function civicrm_api3_case_type_get($params) {
73 if (!empty($params['options']) && !empty($params['options']['is_count'])) {
74 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
76 $caseTypes = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
77 // format case type, to fetch xml definition
78 $options = _civicrm_api3_get_options_from_params($params);
79 return _civicrm_api3_case_type_get_formatResult($caseTypes, $options);
85 * @param array $result
86 * @param array $options
89 * @throws \CRM_Core_Exception
91 function _civicrm_api3_case_type_get_formatResult(&$result, $options = array()) {
92 foreach ($result['values'] as $key => &$caseType) {
93 if (!empty($caseType['definition'])) {
94 list($xml) = CRM_Utils_XML
::parseString($caseType['definition']);
95 $caseType['definition'] = $xml ? CRM_Case_BAO_CaseType
::convertXmlToDefinition($xml) : array();
98 if (empty($options['return']) ||
!empty($options['return']['definition'])) {
99 $caseTypeName = (isset($caseType['name'])) ?
$caseType['name'] : CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseType', $caseType['id'], 'name', 'id', TRUE);
100 $xml = CRM_Case_XMLRepository
::singleton()->retrieve($caseTypeName);
101 $caseType['definition'] = $xml ? CRM_Case_BAO_CaseType
::convertXmlToDefinition($xml) : array();
104 $caseType['is_forkable'] = CRM_Case_BAO_CaseType
::isForkable($caseType['id']);
105 $caseType['is_forked'] = CRM_Case_BAO_CaseType
::isForked($caseType['id']);
111 * Function to delete case type.
113 * @param array $params
114 * Array including id of CaseType to delete.
119 function civicrm_api3_case_type_delete($params) {
120 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);