Commit | Line | Data |
---|---|---|
eaefbeb2 N |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
eaefbeb2 N |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2014 | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * File for the CiviCRM APIv3 Case functions | |
30 | * Developed by woolman.org | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Case | |
34 | * @copyright CiviCRM LLC (c) 2004-2014 | |
35 | * | |
36 | */ | |
37 | ||
38 | /** | |
c490a46a | 39 | * create or update case type |
eaefbeb2 | 40 | * |
cf470720 TO |
41 | * @param array $params |
42 | * Input parameters. | |
eaefbeb2 N |
43 | * |
44 | * Allowed @params array keys are: | |
45 | * {@getfields case_type_create} | |
46 | * | |
47 | * @throws API_Exception | |
a6c01b45 | 48 | * @return array |
72b3a70c | 49 | * API result array |
eaefbeb2 | 50 | * |
eaefbeb2 N |
51 | */ |
52 | function civicrm_api3_case_type_create($params) { | |
c7bccb5f | 53 | civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__)); |
32f1c917 TO |
54 | unset($params['is_forkable']); // computed property |
55 | unset($params['is_forked']); // computed property | |
eaefbeb2 | 56 | |
52ae14f0 | 57 | if (!array_key_exists('is_active', $params) && empty($params['id'])) { |
eaefbeb2 N |
58 | $params['is_active'] = TRUE; |
59 | } | |
32f1c917 TO |
60 | if (!empty($params['id']) // this is an existing case-type |
61 | && !CRM_Case_BAO_CaseType::isForked($params['id']) // which is not yet forked | |
62 | && !CRM_Case_BAO_CaseType::isForkable($params['id']) // for which new forks are prohibited | |
63 | ) { | |
64 | unset($params['definition']); | |
65 | } | |
66 | $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'CaseType'); | |
67 | return _civicrm_api3_case_type_get_formatResult($result); | |
eaefbeb2 N |
68 | } |
69 | ||
70 | /** | |
c490a46a | 71 | * retrieve case types |
eaefbeb2 | 72 | * |
c490a46a | 73 | * @param array $params |
77b97be7 | 74 | * |
a6c01b45 | 75 | * @return array |
72b3a70c | 76 | * case types keyed by id |
eaefbeb2 N |
77 | */ |
78 | function civicrm_api3_case_type_get($params) { | |
4771089b EM |
79 | if (!empty($params['options']) && !empty($params['options']['is_count'])) { |
80 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
81 | } | |
4e95e303 | 82 | $caseTypes = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
4e95e303 | 83 | // format case type, to fetch xml definition |
be663fc7 | 84 | return _civicrm_api3_case_type_get_formatResult($caseTypes); |
4e95e303 | 85 | } |
86 | ||
87 | /** | |
c490a46a | 88 | * format definition |
4e95e303 | 89 | * |
645ee340 | 90 | * @param array $result |
4e95e303 | 91 | * @return mixed |
645ee340 | 92 | * @throws \CRM_Core_Exception |
4e95e303 | 93 | */ |
93d47462 TO |
94 | function _civicrm_api3_case_type_get_formatResult(&$result) { |
95 | foreach ($result['values'] as $key => $caseType) { | |
32f1c917 TO |
96 | $caseTypeName = (isset($caseType['name'])) ? $caseType['name'] : CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseType['id'], 'name', 'id', TRUE); |
97 | $xml = CRM_Case_XMLRepository::singleton()->retrieve($caseTypeName); | |
c2f2bbe6 TO |
98 | if ($xml) { |
99 | $result['values'][$key]['definition'] = CRM_Case_BAO_CaseType::convertXmlToDefinition($xml); | |
0db6c3e1 TO |
100 | } |
101 | else { | |
c2f2bbe6 TO |
102 | $result['values'][$key]['definition'] = array(); |
103 | } | |
32f1c917 TO |
104 | $result['values'][$key]['is_forkable'] = CRM_Case_BAO_CaseType::isForkable($result['values'][$key]['id']); |
105 | $result['values'][$key]['is_forked'] = CRM_Case_BAO_CaseType::isForked($result['values'][$key]['id']); | |
93d47462 TO |
106 | } |
107 | return $result; | |
eaefbeb2 N |
108 | } |
109 | ||
110 | /** | |
111 | * Function to delete case type | |
112 | * | |
cf470720 TO |
113 | * @param array $params |
114 | * Array including id of case_type to delete. | |
eaefbeb2 | 115 | |
a6c01b45 | 116 | * @return array |
72b3a70c | 117 | * API result array |
eaefbeb2 N |
118 | * |
119 | * @access public | |
120 | * | |
121 | */ | |
122 | function civicrm_api3_case_type_delete($params) { | |
123 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
124 | } |