Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM custom group. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
9d32e6f7 EM |
35 | * Use this API to create a new group. |
36 | * | |
37 | * The 'extends' value accepts an array or a comma separated string. | |
6a488035 | 38 | * e.g array( |
d1b0d05e | 39 | * 'Individual','Contact') or 'Individual,Contact' |
6a488035 TO |
40 | * See the CRM Data Model for custom_group property definitions |
41 | * $params['class_name'] is a required field, class being extended. | |
42 | * | |
16b10e64 | 43 | * @param array $params |
2e66abf8 | 44 | * Array per getfields metadata. |
6a488035 | 45 | * |
72b3a70c | 46 | * @return array |
6a488035 | 47 | * @todo $params['extends'] is array format - is that std compatible |
6a488035 TO |
48 | */ |
49 | function civicrm_api3_custom_group_create($params) { | |
882e0216 | 50 | if (isset($params['extends']) && is_string($params['extends'])) { |
6a488035 TO |
51 | $extends = explode(",", $params['extends']); |
52 | unset($params['extends']); | |
53 | $params['extends'] = $extends; | |
54 | } | |
55 | if (!isset($params['extends'][0]) || !trim($params['extends'][0])) { | |
56 | return civicrm_api3_create_error("First item in params['extends'] must be a class name (e.g. 'Contact')."); | |
57 | } | |
58 | if (isset($params['extends_entity_column_value']) && !is_array($params['extends_entity_column_value'])) { | |
59 | // BAO fails if this is a string, but API getFields says this must be a string, so we'll do a double backflip | |
60 | $params['extends_entity_column_value'] = CRM_Utils_Array::explodePadded($params['extends_entity_column_value']); | |
61 | } | |
62 | ||
ea12ce50 | 63 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 TO |
64 | } |
65 | ||
11e09c59 | 66 | /** |
0aa0303c | 67 | * Adjust Metadata for Create action. |
6a488035 | 68 | * |
cf470720 | 69 | * @param array $params |
b081365f | 70 | * Array of parameters determined by getfields. |
6a488035 TO |
71 | */ |
72 | function _civicrm_api3_custom_group_create_spec(&$params) { | |
73 | $params['extends']['api.required'] = 1; | |
74 | $params['title']['api.required'] = 1; | |
75 | $params['style']['api.default'] = 'Inline'; | |
46b88fe1 | 76 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
77 | } |
78 | ||
79 | /** | |
80 | * Use this API to delete an existing group. | |
81 | * | |
decce855 | 82 | * @param array $params |
6a488035 | 83 | * |
decce855 | 84 | * @return array |
c23f45d3 | 85 | */ |
6a488035 | 86 | function civicrm_api3_custom_group_delete($params) { |
6a488035 TO |
87 | $values = new CRM_Core_DAO_CustomGroup(); |
88 | $values->id = $params['id']; | |
89 | $values->find(TRUE); | |
90 | ||
6a488035 TO |
91 | $result = CRM_Core_BAO_CustomGroup::deleteGroup($values, TRUE); |
92 | return $result ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting custom group'); | |
93 | } | |
94 | ||
95 | /** | |
2e66abf8 | 96 | * API to get existing custom fields. |
6a488035 | 97 | * |
cf470720 | 98 | * @param array $params |
2e66abf8 | 99 | * Array per getfields metadata. |
6a488035 | 100 | * |
77b97be7 | 101 | * @return array |
ae5ffbb7 | 102 | */ |
6a488035 TO |
103 | function civicrm_api3_custom_group_get($params) { |
104 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
105 | } | |
106 | ||
5322ae12 | 107 | /** |
9d32e6f7 EM |
108 | * CRM-15191 - Hack to ensure the cache gets cleared after updating a custom group. |
109 | * | |
d0997921 | 110 | * @param array $params |
2e66abf8 | 111 | * Array per getfields metadata. |
9d32e6f7 | 112 | * |
645ee340 | 113 | * @return array |
5322ae12 CW |
114 | */ |
115 | function civicrm_api3_custom_group_setvalue($params) { | |
116 | require_once 'api/v3/Generic/Setvalue.php'; | |
4846df91 | 117 | $result = civicrm_api3_generic_setValue(array("entity" => 'CustomGroup', 'params' => $params)); |
5322ae12 CW |
118 | if (empty($result['is_error'])) { |
119 | CRM_Utils_System::flushCache(); | |
120 | } | |
121 | return $result; | |
122 | } |