3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM custom value.
31 * @package CiviCRM_APIv3
36 * Sets custom values for an entity.
38 * @param array $params
39 * Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID.
43 * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using
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
56 * 'custom_some_group:my_field' => 'myinfo',
57 * // updates record ID 8 in my_other_field in multi-valued some_big_group
58 * 'custom_some_big_group:my_other_field:8' => 'myinfo',
63 * ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong']
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);
72 $create = ['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;
80 list($c, $id) = CRM_Utils_System
::explode('_', $id, 2);
84 list($i, $n, $x) = CRM_Utils_System
::explode(':', $id, 3);
90 // Lookup names if ID was not supplied
91 $key = CRM_Core_BAO_CustomField
::getCustomFieldID($n, $i);
96 if ($x && is_numeric($x)) {
99 $create['custom_' . $key] = $param;
101 $result = CRM_Core_BAO_CustomValueTable
::setValues($create);
102 if ($result['is_error']) {
103 throw new Exception($result['error_message']);
105 return civicrm_api3_create_success(TRUE, $params, 'CustomValue');
109 * Adjust Metadata for Create action.
111 * The metadata is used for setting defaults, documentation & validation.
113 * @param array $params
114 * Array of parameters determined by getfields.
116 function _civicrm_api3_custom_value_create_spec(&$params) {
117 $params['entity_id']['api.required'] = 1;
118 $params['entity_id']['title'] = 'Entity ID';
122 * Use this API to get existing custom values for an entity.
124 * @param array $params
125 * Array specifying the entity_id.
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
133 * @throws API_Exception
136 function civicrm_api3_custom_value_get($params) {
139 'entityID' => $params['entity_id'],
140 'entityType' => CRM_Utils_Array
::value('entity_table', $params, ''),
142 if (strstr($getParams['entityType'], 'civicrm_')) {
143 $getParams['entityType'] = ucfirst(substr($getParams['entityType'], 8));
145 unset($params['entity_id'], $params['entity_table']);
146 foreach ($params as $id => $param) {
147 if ($param && substr($id, 0, 6) == 'return') {
149 if (!empty(substr($id, 7))) {
150 $returnVal = substr($id, 7);
152 if (!is_array($returnVal)) {
153 $returnVal = explode(',', $returnVal);
155 foreach ($returnVal as $value) {
156 list($c, $i) = CRM_Utils_System
::explode('_', $value, 2);
157 if ($c == 'custom' && is_numeric($i)) {
158 $names['custom_' . $i] = 'custom_' . $i;
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);
168 $names['custom_' . $fldId] = 'custom_' . $i;
170 $getParams['custom_' . $fldId] = 1;
175 $result = CRM_Core_BAO_CustomValueTable
::getValues($getParams);
177 if ($result['is_error']) {
178 if ($result['error_message'] == "No values found for the specified entity ID and custom field(s).") {
180 return civicrm_api3_create_success($values, $params, 'CustomValue');
183 throw new API_Exception($result['error_message']);
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));
196 $idArray = explode('_', $id);
197 if ($idArray[0] != 'custom') {
200 $fieldNumber = $idArray[1];
201 $customFieldInfo = CRM_Core_BAO_CustomField
::getNameFromID($fieldNumber);
202 $info = array_pop($customFieldInfo);
203 // id is the index for returned results
205 if (empty($idArray[2])) {
211 $id = $fieldNumber . "." . $idArray[2];
213 if (!empty($params['format.field_names'])) {
214 $id = $info['field_name'];
219 $values[$id]['entity_id'] = $getParams['entityID'];
220 if (!empty($getParams['entityType'])) {
221 $values[$id]['entity_table'] = $getParams['entityType'];
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;
228 return civicrm_api3_create_success($values, $params, 'CustomValue');
233 * Adjust Metadata for Get action.
235 * The metadata is used for setting defaults, documentation & validation.
237 * @param array $params
238 * Array of parameters determined by getfields.
240 function _civicrm_api3_custom_value_get_spec(&$params) {
241 $params['entity_id']['api.required'] = 1;
242 $params['entity_id']['title'] = 'Entity ID';
246 * CustomValue.gettree API specification
248 * @param array $spec description of fields supported by this API call
250 * @throws \CiviCRM_API3_Exception
252 function _civicrm_api3_custom_value_gettree_spec(&$spec) {
253 $spec['entity_id'] = [
254 'title' => 'Entity Id',
255 'description' => 'Id of entity',
256 'type' => CRM_Utils_Type
::T_INT
,
259 $entities = civicrm_api3('Entity', 'get');
260 $entities = array_diff($entities['values'], $entities['deprecated']);
261 $spec['entity_type'] = [
262 'title' => 'Entity Type',
263 'description' => 'API name of entity type, e.g. "Contact"',
264 'type' => CRM_Utils_Type
::T_STRING
,
266 'options' => array_combine($entities, $entities),
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] = ['name' => $name] +
$field;
273 foreach (CRM_Core_DAO_CustomField
::fields() as $field) {
274 $name = 'custom_field.' . $field['name'];
275 $spec[$name] = ['name' => $name] +
$field;
277 $spec['custom_value.id'] = [
278 'title' => 'Custom Value Id',
279 'description' => 'Id of record in custom value table',
280 'type' => CRM_Utils_Type
::T_INT
,
282 $spec['custom_value.data'] = [
283 'title' => 'Custom Value (Raw)',
284 'description' => 'Raw value as stored in the database',
285 'type' => CRM_Utils_Type
::T_STRING
,
287 $spec['custom_value.display'] = [
288 'title' => 'Custom Value (Formatted)',
289 'description' => 'Custom value formatted for display',
290 'type' => CRM_Utils_Type
::T_STRING
,
295 * CustomValue.gettree API
297 * @param array $params
299 * @return array API result
300 * @throws \API_Exception
301 * @throws \CRM_Core_Exception
302 * @throws \CiviCRM_API3_Exception
304 function civicrm_api3_custom_value_gettree($params) {
306 $options = _civicrm_api3_get_options_from_params($params);
308 'custom_group' => [],
309 'custom_field' => [],
310 'custom_value' => [],
312 foreach (array_keys($options['return']) as $r) {
313 list($type, $field) = explode('.', $r);
314 if (isset($toReturn[$type])) {
315 $toReturn[$type][] = $field;
318 // We must have a name if not indexing sequentially
319 if (empty($params['sequential']) && $toReturn['custom_field']) {
320 $toReturn['custom_field'][] = 'name';
322 switch ($params['entity_type']) {
324 $ret = ['entityType' => 'contact_type', 'subTypes' => 'contact_sub_type'];
335 $ret = ['subTypes' => strtolower($params['entity_type']) . '_type_id'];
342 'entityType' => $params['entity_type'],
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', [
350 'id' => $params['entity_id'],
351 'check_permissions' => !empty($params['check_permissions']),
352 'return' => array_merge(['id'], array_values($ret)),
354 foreach ($ret as $param => $key) {
355 if (isset($entityData[$key])) {
356 $treeParams[$param] = $entityData[$key];
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));
361 unset($tree['info']);
363 foreach ($tree as $group) {
364 $result[$group['name']] = [];
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);
369 $result[$group['name']]['fields'] = [];
370 foreach ($group['fields'] as $fieldInfo) {
371 $field = ['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);
376 unset($field['customValue']);
377 if (!empty($fieldInfo['customValue'])) {
378 $field['value'] = CRM_Utils_Array
::first($fieldInfo['customValue']);
379 if (!$toReturn['custom_value'] ||
in_array('display', $toReturn['custom_value'])) {
380 $field['value']['display'] = CRM_Core_BAO_CustomField
::displayValue($field['value']['data'], $fieldInfo);
382 foreach (array_keys($field['value']) as $key) {
383 if ($toReturn['custom_value'] && !in_array($key, $toReturn['custom_value'])) {
384 unset($field['value'][$key]);
388 if (empty($params['sequential'])) {
389 $result[$group['name']]['fields'][$fieldInfo['name']] = $field;
392 $result[$group['name']]['fields'][] = $field;
396 return civicrm_api3_create_success($result, $params, 'CustomValue', 'gettree');