Commit | Line | Data |
---|---|---|
eaefbeb2 N |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.5 | | |
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 | /** | |
39 | * Function to create or update case type | |
40 | * | |
41 | * @param array $params input parameters | |
42 | * | |
43 | * Allowed @params array keys are: | |
44 | * {@getfields case_type_create} | |
45 | * | |
46 | * @throws API_Exception | |
47 | * @return array API result array | |
48 | * | |
49 | * @static void | |
50 | * @access public | |
51 | */ | |
52 | function civicrm_api3_case_type_create($params) { | |
53 | civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__), array('name')); | |
54 | ||
52ae14f0 | 55 | if (!array_key_exists('is_active', $params) && empty($params['id'])) { |
eaefbeb2 N |
56 | $params['is_active'] = TRUE; |
57 | } | |
58 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'CaseType'); | |
59 | ||
60 | } | |
61 | ||
62 | /** | |
63 | * Function to retrieve case types | |
64 | * | |
65 | * @return array $caseTypes case types keyed by id | |
66 | * @access public | |
67 | * | |
68 | */ | |
69 | function civicrm_api3_case_type_get($params) { | |
70 | civicrm_api3_verify_mandatory($params); | |
71 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
72 | } | |
73 | ||
74 | /** | |
75 | * Function to delete case type | |
76 | * | |
77 | * @param array $params array including id of case_type to delete | |
78 | ||
79 | * @return array API result array | |
80 | * | |
81 | * @access public | |
82 | * | |
83 | */ | |
84 | function civicrm_api3_case_type_delete($params) { | |
85 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
86 | } |