Commit | Line | Data |
---|---|---|
eaefbeb2 N |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
eaefbeb2 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
eaefbeb2 N |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
e70a7fc0 | 26 | */ |
eaefbeb2 N |
27 | |
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM Case. |
eaefbeb2 N |
30 | * |
31 | * @package CiviCRM_APIv3 | |
eaefbeb2 N |
32 | */ |
33 | ||
34 | /** | |
9d32e6f7 | 35 | * Create or update case type. |
eaefbeb2 | 36 | * |
cf470720 TO |
37 | * @param array $params |
38 | * Input parameters. | |
eaefbeb2 | 39 | * |
eaefbeb2 | 40 | * @throws API_Exception |
a6c01b45 | 41 | * @return array |
72b3a70c | 42 | * API result array |
eaefbeb2 N |
43 | */ |
44 | function civicrm_api3_case_type_create($params) { | |
c7bccb5f | 45 | civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__)); |
9d32e6f7 EM |
46 | // Computed properties. |
47 | unset($params['is_forkable']); | |
48 | unset($params['is_forked']); | |
eaefbeb2 | 49 | |
52ae14f0 | 50 | if (!array_key_exists('is_active', $params) && empty($params['id'])) { |
eaefbeb2 N |
51 | $params['is_active'] = TRUE; |
52 | } | |
9d32e6f7 | 53 | // This is an existing case-type. |
492121d2 | 54 | if (!empty($params['id']) && isset($params['definition']) |
32f1c917 TO |
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 | |
57 | ) { | |
58 | unset($params['definition']); | |
59 | } | |
60 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'CaseType'); | |
61 | return _civicrm_api3_case_type_get_formatResult($result); | |
eaefbeb2 N |
62 | } |
63 | ||
64 | /** | |
9d32e6f7 | 65 | * Retrieve case types. |
eaefbeb2 | 66 | * |
c490a46a | 67 | * @param array $params |
77b97be7 | 68 | * |
a6c01b45 | 69 | * @return array |
72b3a70c | 70 | * case types keyed by id |
eaefbeb2 N |
71 | */ |
72 | function civicrm_api3_case_type_get($params) { | |
4771089b EM |
73 | if (!empty($params['options']) && !empty($params['options']['is_count'])) { |
74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
75 | } | |
4e95e303 | 76 | $caseTypes = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
4e95e303 | 77 | // format case type, to fetch xml definition |
492121d2 CW |
78 | $options = _civicrm_api3_get_options_from_params($params); |
79 | return _civicrm_api3_case_type_get_formatResult($caseTypes, $options); | |
4e95e303 | 80 | } |
81 | ||
82 | /** | |
9d32e6f7 | 83 | * Format definition. |
4e95e303 | 84 | * |
645ee340 | 85 | * @param array $result |
492121d2 | 86 | * @param array $options |
9d32e6f7 | 87 | * |
c23f45d3 | 88 | * @return array |
645ee340 | 89 | * @throws \CRM_Core_Exception |
4e95e303 | 90 | */ |
492121d2 CW |
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(); | |
0db6c3e1 TO |
96 | } |
97 | else { | |
492121d2 CW |
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(); | |
102 | } | |
c2f2bbe6 | 103 | } |
492121d2 CW |
104 | $caseType['is_forkable'] = CRM_Case_BAO_CaseType::isForkable($caseType['id']); |
105 | $caseType['is_forked'] = CRM_Case_BAO_CaseType::isForked($caseType['id']); | |
93d47462 TO |
106 | } |
107 | return $result; | |
eaefbeb2 N |
108 | } |
109 | ||
110 | /** | |
9d32e6f7 | 111 | * Function to delete case type. |
eaefbeb2 | 112 | * |
cf470720 | 113 | * @param array $params |
244bbdd8 | 114 | * Array including id of CaseType to delete. |
c23f45d3 | 115 | * |
a6c01b45 | 116 | * @return array |
72b3a70c | 117 | * API result array |
eaefbeb2 N |
118 | */ |
119 | function civicrm_api3_case_type_delete($params) { | |
120 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
121 | } |