Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM custom value. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 TO |
34 | |
35 | /** | |
36 | * Sets custom values for an entity. | |
37 | * | |
16b10e64 | 38 | * @param array $params |
cf470720 | 39 | * Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID. |
16b10e64 | 40 | * |
c28e1768 CW |
41 | * @example: |
42 | * @code | |
16b10e64 CW |
43 | * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using |
44 | * 'entity_id' => 123, | |
45 | * // (omitting :id) inserts or updates a field in a single-valued group | |
46 | * 'custom_6' => 'foo', | |
47 | * // custom_24 is checkbox or multiselect, so pass items as an array | |
48 | * 'custom_24' => array('bar', 'baz'), | |
49 | * // in this case custom_33 is part of a multi-valued group, and we're updating record id 5 | |
50 | * 'custom_33:5' => value, | |
51 | * // inserts new record in multi-valued group | |
52 | * 'custom_33:-1' => value, | |
53 | * // inserts another new record in multi-valued group | |
54 | * 'custom_33:-2' => value, | |
55 | * // you can use group_name:field_name instead of ID | |
c28e1768 | 56 | * 'custom_some_group:my_field' => 'myinfo', |
16b10e64 | 57 | * // updates record ID 8 in my_other_field in multi-valued some_big_group |
c28e1768 CW |
58 | * 'custom_some_big_group:my_other_field:8' => 'myinfo', |
59 | * @endcode | |
6a488035 | 60 | * |
77b97be7 | 61 | * @throws Exception |
16b10e64 CW |
62 | * @return array |
63 | * ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong'] | |
6a488035 TO |
64 | */ |
65 | function civicrm_api3_custom_value_create($params) { | |
66 | // @todo it's not clear where the entity_table is used as CRM_Core_BAO_CustomValueTable::setValues($create) | |
67 | // didn't seem to use it | |
68 | // so not clear if it's relevant | |
69 | if (!empty($params['entity_table']) && substr($params['entity_table'], 0, 7) == 'civicrm') { | |
70 | $params['entity_table'] = substr($params['entity_table'], 8, 7); | |
71 | } | |
72 | $create = array('entityID' => $params['entity_id']); | |
73 | // Translate names and | |
74 | //Convert arrays to multi-value strings | |
75 | $sp = CRM_Core_DAO::VALUE_SEPARATOR; | |
76 | foreach ($params as $id => $param) { | |
77 | if (is_array($param)) { | |
78 | $param = $sp . implode($sp, $param) . $sp; | |
79 | } | |
80 | list($c, $id) = CRM_Utils_System::explode('_', $id, 2); | |
81 | if ($c != 'custom') { | |
82 | continue; | |
83 | } | |
84 | list($i, $n, $x) = CRM_Utils_System::explode(':', $id, 3); | |
85 | if (is_numeric($i)) { | |
86 | $key = $i; | |
87 | $x = $n; | |
88 | } | |
89 | else { | |
90 | // Lookup names if ID was not supplied | |
91 | $key = CRM_Core_BAO_CustomField::getCustomFieldID($n, $i); | |
92 | if (!$key) { | |
93 | continue; | |
94 | } | |
95 | } | |
96 | if ($x && is_numeric($x)) { | |
97 | $key .= '_' . $x; | |
98 | } | |
99 | $create['custom_' . $key] = $param; | |
100 | } | |
101 | $result = CRM_Core_BAO_CustomValueTable::setValues($create); | |
102 | if ($result['is_error']) { | |
103 | throw new Exception($result['error_message']); | |
104 | } | |
244bbdd8 | 105 | return civicrm_api3_create_success(TRUE, $params, 'CustomValue'); |
6a488035 | 106 | } |
11e09c59 TO |
107 | |
108 | /** | |
0aa0303c EM |
109 | * Adjust Metadata for Create action. |
110 | * | |
111 | * The metadata is used for setting defaults, documentation & validation. | |
11e09c59 | 112 | * |
cf470720 | 113 | * @param array $params |
b081365f | 114 | * Array of parameters determined by getfields. |
11e09c59 | 115 | */ |
6a488035 TO |
116 | function _civicrm_api3_custom_value_create_spec(&$params) { |
117 | $params['entity_id']['api.required'] = 1; | |
1fdb479f | 118 | $params['entity_id']['title'] = 'Entity ID'; |
6a488035 | 119 | } |
77b97be7 | 120 | |
6a488035 TO |
121 | /** |
122 | * Use this API to get existing custom values for an entity. | |
123 | * | |
16b10e64 | 124 | * @param array $params |
cf470720 | 125 | * Array specifying the entity_id. |
16b10e64 CW |
126 | * Optionally include entity_type param, i.e. 'entity_type' => 'Activity' |
127 | * If no entity_type is supplied, it will be determined based on the fields you request. | |
128 | * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed. | |
129 | * Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned) | |
130 | * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1 | |
131 | * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1 | |
6a488035 | 132 | * |
77b97be7 | 133 | * @throws API_Exception |
a6c01b45 | 134 | * @return array |
11e09c59 | 135 | */ |
6a488035 TO |
136 | function civicrm_api3_custom_value_get($params) { |
137 | ||
138 | $getParams = array( | |
139 | 'entityID' => $params['entity_id'], | |
140 | 'entityType' => CRM_Utils_Array::value('entity_table', $params, ''), | |
141 | ); | |
142 | if (strstr($getParams['entityType'], 'civicrm_')) { | |
143 | $getParams['entityType'] = ucfirst(substr($getParams['entityType'], 8)); | |
144 | } | |
145 | unset($params['entity_id'], $params['entity_table']); | |
146 | foreach ($params as $id => $param) { | |
147 | if ($param && substr($id, 0, 6) == 'return') { | |
bc3c9f57 JP |
148 | $returnVal = $param; |
149 | if (!empty(substr($id, 7))) { | |
150 | $returnVal = substr($id, 7); | |
6a488035 | 151 | } |
55000cc7 T |
152 | if (!is_array($returnVal)) { |
153 | $returnVal = explode(',', $returnVal); | |
154 | } | |
155 | foreach ($returnVal as $value) { | |
bc3c9f57 JP |
156 | list($c, $i) = CRM_Utils_System::explode('_', $value, 2); |
157 | if ($c == 'custom' && is_numeric($i)) { | |
158 | $names['custom_' . $i] = 'custom_' . $i; | |
159 | $fldId = $i; | |
6a488035 | 160 | } |
bc3c9f57 JP |
161 | else { |
162 | // Lookup names if ID was not supplied | |
163 | list($group, $field) = CRM_Utils_System::explode(':', $value, 2); | |
164 | $fldId = CRM_Core_BAO_CustomField::getCustomFieldID($field, $group); | |
165 | if (!$fldId) { | |
166 | continue; | |
167 | } | |
168 | $names['custom_' . $fldId] = 'custom_' . $i; | |
169 | } | |
170 | $getParams['custom_' . $fldId] = 1; | |
6a488035 | 171 | } |
6a488035 TO |
172 | } |
173 | } | |
174 | ||
175 | $result = CRM_Core_BAO_CustomValueTable::getValues($getParams); | |
176 | ||
177 | if ($result['is_error']) { | |
178 | if ($result['error_message'] == "No values found for the specified entity ID and custom field(s).") { | |
179 | $values = array(); | |
244bbdd8 | 180 | return civicrm_api3_create_success($values, $params, 'CustomValue'); |
6a488035 TO |
181 | } |
182 | else { | |
b422b715 | 183 | throw new API_Exception($result['error_message']); |
6a488035 TO |
184 | } |
185 | } | |
186 | else { | |
187 | $entity_id = $result['entityID']; | |
188 | unset($result['is_error'], $result['entityID']); | |
189 | // Convert multi-value strings to arrays | |
190 | $sp = CRM_Core_DAO::VALUE_SEPARATOR; | |
191 | foreach ($result as $id => $value) { | |
192 | if (strpos($value, $sp) !== FALSE) { | |
193 | $value = explode($sp, trim($value, $sp)); | |
194 | } | |
195 | ||
196 | $idArray = explode('_', $id); | |
197 | if ($idArray[0] != 'custom') { | |
198 | continue; | |
199 | } | |
200 | $fieldNumber = $idArray[1]; | |
512cceb4 PJ |
201 | $customFieldInfo = CRM_Core_BAO_CustomField::getNameFromID($fieldNumber); |
202 | $info = array_pop($customFieldInfo); | |
6a488035 TO |
203 | // id is the index for returned results |
204 | ||
205 | if (empty($idArray[2])) { | |
206 | $n = 0; | |
207 | $id = $fieldNumber; | |
208 | } | |
92e4c2a5 | 209 | else { |
6a488035 TO |
210 | $n = $idArray[2]; |
211 | $id = $fieldNumber . "." . $idArray[2]; | |
212 | } | |
a7488080 | 213 | if (!empty($params['format.field_names'])) { |
6a488035 TO |
214 | $id = $info['field_name']; |
215 | } | |
216 | else { | |
217 | $id = $fieldNumber; | |
218 | } | |
219 | $values[$id]['entity_id'] = $getParams['entityID']; | |
a7488080 | 220 | if (!empty($getParams['entityType'])) { |
4f2aa1a2 | 221 | $values[$id]['entity_table'] = $getParams['entityType']; |
6a488035 TO |
222 | } |
223 | //set 'latest' -useful for multi fields but set for single for consistency | |
224 | $values[$id]['latest'] = $value; | |
225 | $values[$id]['id'] = $id; | |
226 | $values[$id][$n] = $value; | |
227 | } | |
244bbdd8 | 228 | return civicrm_api3_create_success($values, $params, 'CustomValue'); |
6a488035 TO |
229 | } |
230 | } | |
231 | ||
11e09c59 | 232 | /** |
dc64d047 | 233 | * Adjust Metadata for Get action. |
11e09c59 | 234 | * |
0aa0303c EM |
235 | * The metadata is used for setting defaults, documentation & validation. |
236 | * | |
cf470720 | 237 | * @param array $params |
b081365f | 238 | * Array of parameters determined by getfields. |
11e09c59 | 239 | */ |
6a488035 TO |
240 | function _civicrm_api3_custom_value_get_spec(&$params) { |
241 | $params['entity_id']['api.required'] = 1; | |
4c41ecb2 | 242 | $params['entity_id']['title'] = 'Entity ID'; |
232624b1 | 243 | } |
24871985 CW |
244 | |
245 | /** | |
246 | * CustomValue.gettree API specification | |
247 | * | |
248 | * @param array $spec description of fields supported by this API call | |
aa965915 MWMC |
249 | * |
250 | * @throws \CiviCRM_API3_Exception | |
24871985 CW |
251 | */ |
252 | function _civicrm_api3_custom_value_gettree_spec(&$spec) { | |
253 | $spec['entity_id'] = array( | |
254 | 'title' => 'Entity Id', | |
255 | 'description' => 'Id of entity', | |
256 | 'type' => CRM_Utils_Type::T_INT, | |
257 | 'api.required' => 1, | |
258 | ); | |
259 | $entities = civicrm_api3('Entity', 'get'); | |
260 | $entities = array_diff($entities['values'], $entities['deprecated']); | |
261 | $spec['entity_type'] = array( | |
262 | 'title' => 'Entity Type', | |
263 | 'description' => 'API name of entity type, e.g. "Contact"', | |
264 | 'type' => CRM_Utils_Type::T_STRING, | |
265 | 'api.required' => 1, | |
266 | 'options' => array_combine($entities, $entities), | |
267 | ); | |
0b330e6d CW |
268 | // Return params for custom group, field & value |
269 | foreach (CRM_Core_DAO_CustomGroup::fields() as $field) { | |
270 | $name = 'custom_group.' . $field['name']; | |
271 | $spec[$name] = array('name' => $name) + $field; | |
272 | } | |
273 | foreach (CRM_Core_DAO_CustomField::fields() as $field) { | |
274 | $name = 'custom_field.' . $field['name']; | |
275 | $spec[$name] = array('name' => $name) + $field; | |
276 | } | |
277 | $spec['custom_value.id'] = array( | |
278 | 'title' => 'Custom Value Id', | |
279 | 'description' => 'Id of record in custom value table', | |
280 | 'type' => CRM_Utils_Type::T_INT, | |
281 | ); | |
282 | $spec['custom_value.data'] = array( | |
283 | 'title' => 'Custom Value (Raw)', | |
284 | 'description' => 'Raw value as stored in the database', | |
285 | 'type' => CRM_Utils_Type::T_STRING, | |
286 | ); | |
287 | $spec['custom_value.display'] = array( | |
288 | 'title' => 'Custom Value (Formatted)', | |
289 | 'description' => 'Custom value formatted for display', | |
290 | 'type' => CRM_Utils_Type::T_STRING, | |
291 | ); | |
24871985 CW |
292 | } |
293 | ||
294 | /** | |
295 | * CustomValue.gettree API | |
296 | * | |
297 | * @param array $params | |
aa965915 | 298 | * |
24871985 | 299 | * @return array API result |
aa965915 MWMC |
300 | * @throws \API_Exception |
301 | * @throws \CRM_Core_Exception | |
302 | * @throws \CiviCRM_API3_Exception | |
24871985 CW |
303 | */ |
304 | function civicrm_api3_custom_value_gettree($params) { | |
305 | $ret = array(); | |
306 | $options = _civicrm_api3_get_options_from_params($params); | |
307 | $toReturn = array( | |
308 | 'custom_group' => array(), | |
309 | 'custom_field' => array(), | |
310 | 'custom_value' => array(), | |
311 | ); | |
312 | foreach (array_keys($options['return']) as $r) { | |
313 | list($type, $field) = explode('.', $r); | |
314 | if (isset($toReturn[$type])) { | |
315 | $toReturn[$type][] = $field; | |
316 | } | |
317 | } | |
0b330e6d CW |
318 | // We must have a name if not indexing sequentially |
319 | if (empty($params['sequential']) && $toReturn['custom_field']) { | |
320 | $toReturn['custom_field'][] = 'name'; | |
321 | } | |
24871985 CW |
322 | switch ($params['entity_type']) { |
323 | case 'Contact': | |
324 | $ret = array('entityType' => 'contact_type', 'subTypes' => 'contact_sub_type'); | |
325 | break; | |
326 | ||
327 | case 'Activity': | |
328 | case 'Campaign': | |
329 | case 'Case': | |
330 | case 'Contribution': | |
331 | case 'Event': | |
332 | case 'Grant': | |
333 | case 'Membership': | |
334 | case 'Relationship': | |
335 | $ret = array('subTypes' => strtolower($params['entity_type']) . '_type_id'); | |
336 | break; | |
337 | ||
338 | case 'Participant': | |
339 | // todo | |
340 | } | |
341 | $treeParams = array( | |
342 | 'entityType' => $params['entity_type'], | |
343 | 'subTypes' => array(), | |
344 | 'subName' => NULL, | |
345 | ); | |
346 | // Fetch entity data for custom group type/sub-type | |
347 | // Also verify access permissions (api3 will throw an exception if permission denied) | |
348 | if ($ret || !empty($params['check_permissions'])) { | |
349 | $entityData = civicrm_api3($params['entity_type'], 'getsingle', array( | |
350 | 'id' => $params['entity_id'], | |
f26fa703 | 351 | 'check_permissions' => !empty($params['check_permissions']), |
24871985 CW |
352 | 'return' => array_merge(array('id'), array_values($ret)), |
353 | )); | |
354 | foreach ($ret as $param => $key) { | |
355 | if (isset($entityData[$key])) { | |
356 | $treeParams[$param] = $entityData[$key]; | |
357 | } | |
358 | } | |
359 | } | |
0b330e6d | 360 | $tree = CRM_Core_BAO_CustomGroup::getTree($treeParams['entityType'], $toReturn, $params['entity_id'], NULL, $treeParams['subTypes'], $treeParams['subName'], TRUE, NULL, FALSE, CRM_Utils_Array::value('check_permissions', $params, TRUE)); |
24871985 CW |
361 | unset($tree['info']); |
362 | $result = array(); | |
363 | foreach ($tree as $group) { | |
364 | $result[$group['name']] = array(); | |
365 | $groupToReturn = $toReturn['custom_group'] ? $toReturn['custom_group'] : array_keys($group); | |
366 | foreach ($groupToReturn as $item) { | |
367 | $result[$group['name']][$item] = CRM_Utils_Array::value($item, $group); | |
368 | } | |
369 | $result[$group['name']]['fields'] = array(); | |
370 | foreach ($group['fields'] as $fieldInfo) { | |
371 | $field = array('value' => NULL); | |
372 | $fieldToReturn = $toReturn['custom_field'] ? $toReturn['custom_field'] : array_keys($fieldInfo); | |
373 | foreach ($fieldToReturn as $item) { | |
374 | $field[$item] = CRM_Utils_Array::value($item, $fieldInfo); | |
375 | } | |
376 | unset($field['customValue']); | |
377 | if (!empty($fieldInfo['customValue'])) { | |
378 | $field['value'] = CRM_Utils_Array::first($fieldInfo['customValue']); | |
e6446db2 CW |
379 | if (!$toReturn['custom_value'] || in_array('display', $toReturn['custom_value'])) { |
380 | $field['value']['display'] = CRM_Core_BAO_CustomField::displayValue($field['value']['data'], $fieldInfo); | |
381 | } | |
24871985 CW |
382 | foreach (array_keys($field['value']) as $key) { |
383 | if ($toReturn['custom_value'] && !in_array($key, $toReturn['custom_value'])) { | |
384 | unset($field['value'][$key]); | |
385 | } | |
386 | } | |
24871985 CW |
387 | } |
388 | if (empty($params['sequential'])) { | |
389 | $result[$group['name']]['fields'][$fieldInfo['name']] = $field; | |
390 | } | |
391 | else { | |
392 | $result[$group['name']]['fields'][] = $field; | |
393 | } | |
394 | } | |
395 | } | |
396 | return civicrm_api3_create_success($result, $params, 'CustomValue', 'gettree'); | |
397 | } |