Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM configuration settings. |
6a488035 | 30 | * |
b081365f | 31 | * @package CiviCRM_APIv3 |
61fe4988 EM |
32 | */ |
33 | ||
34 | /** | |
35 | * Get fields for setting api calls. | |
36 | * | |
d0997921 | 37 | * @param array $params |
61fe4988 | 38 | * |
645ee340 | 39 | * @return array |
6a488035 | 40 | */ |
6a488035 | 41 | function civicrm_api3_setting_getfields($params) { |
9b873358 | 42 | if (!empty($params['action']) && strtolower($params['action']) == 'getvalue') { |
6a488035 TO |
43 | $result = array( |
44 | 'name' => array( | |
45 | 'title' => 'name of setting field', | |
46 | 'api.required' => 1, | |
47 | 'type' => CRM_Utils_Type::T_STRING), | |
c14d6dd1 | 48 | 'group' => array( |
6a488035 | 49 | 'api.required' => 0, |
1fdb479f | 50 | 'title' => 'Setting Group', |
6a488035 | 51 | 'description' => 'Settings Group. This is required if the setting is not stored in config', |
21dfd5f5 | 52 | 'type' => CRM_Utils_Type::T_STRING), |
e7483cbe | 53 | ); |
244bbdd8 | 54 | return civicrm_api3_create_success($result, $params, 'Setting', 'getfields'); |
6a488035 | 55 | } |
9b873358 | 56 | if (!empty($params['name'])) { |
6a488035 TO |
57 | //am of two minds about special handling for 'name' as opposed to other filters - but is does make most common |
58 | //usage really easy | |
59 | $params['filters']['name'] = $params['name']; | |
60 | } | |
61 | $result = CRM_Core_BAO_Setting::getSettingSpecification( | |
35671d00 | 62 | CRM_Utils_Array::value('component_id', $params), |
6a488035 | 63 | CRM_Utils_Array::value('filters', $params, array()), |
35671d00 TO |
64 | CRM_Utils_Array::value('domain_id', $params, NULL), |
65 | CRM_Utils_Array::value('profile', $params, NULL) | |
6a488035 TO |
66 | ); |
67 | // find any supplemental information | |
9b873358 | 68 | if (!empty($params['action'])) { |
f60289e9 | 69 | $specFunction = '_civicrm_api3_setting_' . strtolower($params['action']) . '_spec'; |
6a488035 TO |
70 | if (function_exists($specFunction)) { |
71 | $specFunction($result); | |
72 | } | |
73 | } | |
244bbdd8 | 74 | return civicrm_api3_create_success($result, $params, 'Setting', 'getfields'); |
6a488035 | 75 | } |
11e09c59 TO |
76 | |
77 | /** | |
1747ab99 EM |
78 | * Alter metadata for getfields functions. |
79 | * | |
d0997921 | 80 | * @param array $params |
6a488035 | 81 | */ |
f60289e9 | 82 | function _civicrm_api3_setting_getfields_spec(&$params) { |
b2ed8e73 CW |
83 | $params['filters'] = array( |
84 | 'title' => 'Filters', | |
85 | 'description' => 'Fields you wish to filter by e.g. array("group_name" => "CiviCRM Preferences")', | |
86 | ); | |
87 | $params['component_id'] = array( | |
88 | 'title' => 'Component ID', | |
89 | 'description' => 'ID of relevant component', | |
90 | ); | |
91 | $params['profile'] = array( | |
92 | 'title' => 'Profile', | |
93 | 'description' => 'Profile is passed through to hooks & added to cachestring', | |
94 | ); | |
6a488035 | 95 | } |
11e09c59 TO |
96 | |
97 | /** | |
1747ab99 EM |
98 | * Return default values for settings. |
99 | * | |
100 | * We will domain key this as it could vary by domain (ie. urls) | |
6a488035 | 101 | * as we will be creating the option for a function rather than an value to be in the defaults |
1747ab99 EM |
102 | * Note that is not in place as yet. |
103 | * | |
d0997921 | 104 | * @param array $params |
1747ab99 | 105 | * |
645ee340 EM |
106 | * @return array |
107 | * @throws \CiviCRM_API3_Exception | |
108 | * @throws \Exception | |
6a488035 | 109 | */ |
9b873358 | 110 | function civicrm_api3_setting_getdefaults(&$params) { |
244bbdd8 | 111 | $settings = civicrm_api3('Setting', 'getfields', $params); |
6a488035 TO |
112 | $domains = _civicrm_api3_setting_getDomainArray($params); |
113 | $defaults = array(); | |
9b873358 | 114 | foreach ($domains as $domainID) { |
6a488035 TO |
115 | $defaults[$domainID] = array(); |
116 | $noDefaults = array(); | |
9b873358 TO |
117 | foreach ($settings['values'] as $setting => $spec) { |
118 | if (array_key_exists('default', $spec) && !is_null($spec['default'])) { | |
6a488035 TO |
119 | $defaults[$domainID][$setting] = $spec['default']; |
120 | } | |
92e4c2a5 | 121 | else { |
6a488035 TO |
122 | $noDefaults[$setting] = 1; |
123 | } | |
124 | } | |
9b873358 | 125 | if (!empty($params['debug'])) { |
6a488035 TO |
126 | // we are only tracking 'noDefaults' to help us check the xml |
127 | print_r($noDefaults); | |
128 | } | |
129 | } | |
244bbdd8 | 130 | return civicrm_api3_create_success($defaults, $params, 'Setting', 'getfields'); |
6a488035 | 131 | } |
11e09c59 | 132 | /** |
244bbdd8 | 133 | * Metadata for Setting create function. |
11e09c59 | 134 | * |
cf470720 TO |
135 | * @param array $params |
136 | * Parameters as passed to the API. | |
11e09c59 | 137 | */ |
f60289e9 | 138 | function _civicrm_api3_setting_getdefaults_spec(&$params) { |
6a488035 | 139 | $params['domain_id'] = array( |
5a159702 EM |
140 | 'api.default' => 'current_domain', |
141 | 'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the current domain | |
142 | an array or "all" are acceptable values for multiple domains', | |
143 | 'title' => 'Setting Domain', | |
6a488035 TO |
144 | ); |
145 | } | |
11e09c59 TO |
146 | |
147 | /** | |
9d32e6f7 EM |
148 | * Revert settings to defaults. |
149 | * | |
d0997921 | 150 | * @param array $params |
9d32e6f7 | 151 | * |
645ee340 EM |
152 | * @return array |
153 | * @throws \Exception | |
6a488035 | 154 | */ |
9b873358 | 155 | function civicrm_api3_setting_revert(&$params) { |
244bbdd8 CW |
156 | $defaults = civicrm_api('Setting', 'getdefaults', $params); |
157 | $fields = civicrm_api('Setting', 'getfields', $params); | |
6a488035 TO |
158 | $fields = $fields['values']; |
159 | $domains = _civicrm_api3_setting_getDomainArray($params); | |
160 | $result = array(); | |
9b873358 | 161 | foreach ($domains as $domainID) { |
6a488035 | 162 | $valuesToRevert = array_intersect_key($defaults['values'][$domainID], $fields); |
9b873358 | 163 | if (!empty($valuesToRevert)) { |
6a488035 TO |
164 | $valuesToRevert['version'] = $params['version']; |
165 | $valuesToRevert['domain_id'] = $domainID; | |
166 | // note that I haven't looked at how the result would appear with multiple domains in play | |
244bbdd8 | 167 | $result = array_merge($result, civicrm_api('Setting', 'create', $valuesToRevert)); |
6a488035 TO |
168 | } |
169 | } | |
170 | ||
244bbdd8 | 171 | return civicrm_api3_create_success($result, $params, 'Setting', 'revert'); |
6a488035 | 172 | } |
11e09c59 TO |
173 | |
174 | /** | |
dc64d047 EM |
175 | * Alter metadata for getfields functions. |
176 | * | |
d0997921 | 177 | * @param array $params |
11e09c59 | 178 | */ |
f60289e9 | 179 | function _civicrm_api3_setting_revert_spec(&$params) { |
b2ed8e73 CW |
180 | $params['name'] = array( |
181 | 'title' => 'Name', | |
182 | 'description' => 'Setting Name belongs to', | |
183 | ); | |
184 | $params['component_id'] = array( | |
185 | 'title' => 'Component ID', | |
186 | 'description' => 'ID of relevant component', | |
187 | ); | |
6a488035 TO |
188 | $params['domain_id'] = array( |
189 | 'api.default' => 'current_domain', | |
dc64d047 EM |
190 | 'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the current domain' |
191 | . ' an array or "all" are acceptable values for multiple domains', | |
5a159702 | 192 | 'title' => 'Setting Domain', |
6a488035 TO |
193 | ); |
194 | } | |
195 | ||
11e09c59 | 196 | /** |
1747ab99 EM |
197 | * Revert settings to defaults. |
198 | * | |
d0997921 | 199 | * @param array $params |
1747ab99 | 200 | * |
645ee340 EM |
201 | * @return array |
202 | * @throws \CiviCRM_API3_Exception | |
203 | * @throws \Exception | |
11e09c59 | 204 | */ |
9b873358 | 205 | function civicrm_api3_setting_fill(&$params) { |
244bbdd8 | 206 | $defaults = civicrm_api3('Setting', 'getdefaults', $params); |
6a488035 TO |
207 | $domains = _civicrm_api3_setting_getDomainArray($params); |
208 | $result = array(); | |
9b873358 | 209 | foreach ($domains as $domainID) { |
6a488035 TO |
210 | $apiArray = array( |
211 | 'version' => $params['version'], | |
21dfd5f5 | 212 | 'domain_id' => $domainID, |
6a488035 | 213 | ); |
244bbdd8 | 214 | $existing = civicrm_api3('Setting', 'get', $apiArray); |
6a488035 | 215 | $valuesToFill = array_diff_key($defaults['values'][$domainID], $existing['values'][$domainID]); |
9b873358 | 216 | if (!empty($valuesToFill)) { |
244bbdd8 | 217 | $result = array_merge($result, civicrm_api('Setting', 'create', $valuesToFill + $apiArray)); |
6a488035 TO |
218 | } |
219 | } | |
244bbdd8 | 220 | return civicrm_api3_create_success($result, $params, 'Setting', 'fill'); |
6a488035 | 221 | } |
11e09c59 TO |
222 | |
223 | /** | |
9d32e6f7 EM |
224 | * Alter metadata for getfields functions. |
225 | * | |
d0997921 | 226 | * @param array $params |
11e09c59 | 227 | */ |
f60289e9 | 228 | function _civicrm_api3_setting_fill_spec(&$params) { |
b2ed8e73 CW |
229 | $params['name'] = array( |
230 | 'title' => 'Name', | |
231 | 'description' => 'Setting Name belongs to', | |
232 | ); | |
233 | $params['component_id'] = array( | |
234 | 'title' => 'Component ID', | |
235 | 'description' => 'ID of relevant component', | |
236 | ); | |
6a488035 | 237 | $params['domain_id'] = array( |
5a159702 EM |
238 | 'api.default' => 'current_domain', |
239 | 'title' => 'Setting Domain', | |
1747ab99 | 240 | 'description' => 'Defaults may differ by domain - if you do not pass in a domain id this will default to the ' |
dc64d047 | 241 | . 'current domain, an array or "all" are acceptable values for multiple domains', |
6a488035 TO |
242 | ); |
243 | } | |
244 | ||
245 | /** | |
35823763 | 246 | * Create or update a setting. |
6a488035 | 247 | * |
cf470720 | 248 | * @param array $params |
35823763 | 249 | * Parameters as per getfields. |
6a488035 | 250 | * |
a6c01b45 | 251 | * @return array |
72b3a70c | 252 | * api result array |
6a488035 TO |
253 | */ |
254 | function civicrm_api3_setting_create($params) { | |
255 | $domains = _civicrm_api3_setting_getDomainArray($params); | |
256 | $result = CRM_Core_BAO_Setting::setItems($params, $domains); | |
244bbdd8 | 257 | return civicrm_api3_create_success($result, $params, 'Setting', 'create'); |
6a488035 | 258 | } |
11e09c59 TO |
259 | |
260 | /** | |
1747ab99 | 261 | * Metadata for setting create function. |
6a488035 | 262 | * |
cf470720 TO |
263 | * @param array $params |
264 | * Parameters as passed to the API. | |
6a488035 | 265 | */ |
f60289e9 | 266 | function _civicrm_api3_setting_create_spec(&$params) { |
6a488035 TO |
267 | $params['domain_id'] = array( |
268 | 'api.default' => 'current_domain', | |
5a159702 | 269 | 'title' => 'Setting Domain', |
6a488035 | 270 | 'description' => 'if you do not pass in a domain id this will default to the current domain |
21dfd5f5 | 271 | an array or "all" are acceptable values for multiple domains', |
e7483cbe | 272 | ); |
35671d00 | 273 | $params['group'] = array( |
e7483cbe J |
274 | 'title' => 'Setting Group', |
275 | 'description' => 'if you know the group defining it will make the api more efficient', | |
276 | ); | |
6a488035 TO |
277 | } |
278 | ||
279 | /** | |
35823763 | 280 | * Returns array of settings matching input parameters. |
6a488035 | 281 | * |
cf470720 | 282 | * @param array $params |
35823763 | 283 | * Array of one or more valid property_name=>value pairs. |
6a488035 | 284 | * |
a6c01b45 | 285 | * @return array |
72b3a70c | 286 | * Array of matching settings |
6a488035 TO |
287 | */ |
288 | function civicrm_api3_setting_get($params) { | |
289 | $domains = _civicrm_api3_setting_getDomainArray($params); | |
35671d00 | 290 | $result = $result = CRM_Core_BAO_Setting::getItems($params, $domains, CRM_Utils_Array::value('return', $params, array())); |
244bbdd8 | 291 | return civicrm_api3_create_success($result, $params, 'Setting', 'get'); |
6a488035 | 292 | } |
11e09c59 | 293 | /** |
1747ab99 | 294 | * Metadata for setting create function. |
11e09c59 | 295 | * |
cf470720 TO |
296 | * @param array $params |
297 | * Parameters as passed to the API. | |
11e09c59 | 298 | */ |
f60289e9 | 299 | function _civicrm_api3_setting_get_spec(&$params) { |
6a488035 | 300 | $params['domain_id'] = array( |
5a159702 EM |
301 | 'api.default' => 'current_domain', |
302 | 'title' => 'Setting Domain', | |
21dfd5f5 | 303 | 'description' => 'if you do not pass in a domain id this will default to the current domain', |
6a488035 TO |
304 | ); |
305 | $params['group'] = array( | |
5a159702 | 306 | 'title' => 'Setting Group', |
21dfd5f5 | 307 | 'description' => 'if you know the group defining it will make the api more efficient', |
35671d00 | 308 | ); |
6a488035 TO |
309 | } |
310 | /** | |
1747ab99 EM |
311 | * Returns value for specific parameter. |
312 | * | |
313 | * Function requires more fields than 'get' but is intended for | |
6a488035 TO |
314 | * runtime usage & should be quicker |
315 | * | |
cf470720 | 316 | * @param array $params |
1747ab99 | 317 | * Array of one or more valid. |
6a488035 TO |
318 | * property_name=>value pairs. |
319 | * | |
a6c01b45 | 320 | * @return array |
1747ab99 | 321 | * API result array. |
6a488035 TO |
322 | */ |
323 | function civicrm_api3_setting_getvalue($params) { | |
324 | $config = CRM_Core_Config::singleton(); | |
9b873358 | 325 | if (isset($config->$params['name'])) { |
6a488035 TO |
326 | return $config->$params['name']; |
327 | } | |
328 | return CRM_Core_BAO_Setting::getItem( | |
329 | $params['group'], | |
330 | CRM_Utils_Array::value('name', $params), | |
331 | CRM_Utils_Array::value('component_id', $params), | |
332 | CRM_Utils_Array::value('default_value', $params), | |
333 | CRM_Utils_Array::value('contact_id', $params), | |
334 | CRM_Utils_Array::value('domain_id', $params) | |
335 | ); | |
336 | } | |
337 | ||
11e09c59 | 338 | /** |
1747ab99 | 339 | * Metadata for setting create function. |
11e09c59 | 340 | * |
cf470720 TO |
341 | * @param array $params |
342 | * Parameters as passed to the API. | |
11e09c59 | 343 | */ |
f60289e9 | 344 | function _civicrm_api3_setting_getvalue_spec(&$params) { |
6a488035 TO |
345 | |
346 | $params['group'] = array( | |
e7483cbe J |
347 | 'title' => 'Settings Group', |
348 | 'api.required' => TRUE, | |
6a488035 TO |
349 | ); |
350 | $params['name'] = array( | |
e7483cbe J |
351 | 'title' => 'Setting Name', |
352 | 'api.aliases' => array('return'), | |
6a488035 TO |
353 | ); |
354 | $params['default_value'] = array( | |
e7483cbe | 355 | 'title' => 'Default Value', |
6a488035 TO |
356 | ); |
357 | $params['component_id'] = array( | |
e7483cbe | 358 | 'title' => 'Component Id', |
6a488035 TO |
359 | ); |
360 | $params['contact_id'] = array( | |
e7483cbe | 361 | 'title' => 'Contact Id', |
6a488035 TO |
362 | ); |
363 | $params['domain_id'] = array( | |
5a159702 | 364 | 'title' => 'Setting Domain', |
21dfd5f5 | 365 | 'description' => 'if you do not pass in a domain id this will default to the current domain', |
6a488035 TO |
366 | ); |
367 | } | |
11e09c59 TO |
368 | |
369 | /** | |
1747ab99 EM |
370 | * Converts domain input into an array. |
371 | * | |
372 | * If an array is passed in this is used, if 'all' is passed | |
6a488035 | 373 | * in this is converted to 'all arrays' |
f60289e9 | 374 | * |
375 | * Really domain_id should always be set but doing an empty check because at the moment | |
376 | * using crm-editable will pass an id & default won't be applied | |
1747ab99 EM |
377 | * we did talk about id being a pseudonym for domain_id in this api so applying it here. |
378 | * | |
d0997921 | 379 | * @param array $params |
1747ab99 | 380 | * |
645ee340 EM |
381 | * @return array |
382 | * @throws \Exception | |
6a488035 | 383 | */ |
9b873358 TO |
384 | function _civicrm_api3_setting_getDomainArray(&$params) { |
385 | if (empty($params['domain_id']) && isset($params['id'])) { | |
f60289e9 | 386 | $params['domain_id'] = $params['id']; |
387 | } | |
388 | ||
9b873358 | 389 | if ($params['domain_id'] == 'current_domain') { |
6a488035 TO |
390 | $params['domain_id'] = CRM_Core_Config::domainID(); |
391 | } | |
392 | ||
9b873358 | 393 | if ($params['domain_id'] == 'all') { |
35671d00 | 394 | $domainAPIResult = civicrm_api('domain', 'get', array('version' => 3, 'return' => 'id')); |
6a488035 TO |
395 | if (isset($domainAPIResult['values'])) { |
396 | $params['domain_id'] = array_keys($domainAPIResult['values']); | |
397 | } | |
92e4c2a5 | 398 | else { |
6a488035 TO |
399 | throw new Exception('All domains not retrieved - problem with Domain Get api call ' . $domainAPIResult['error_message']); |
400 | } | |
401 | } | |
9b873358 | 402 | if (is_array($params['domain_id'])) { |
6a488035 TO |
403 | $domains = $params['domain_id']; |
404 | } | |
92e4c2a5 | 405 | else { |
6a488035 TO |
406 | $domains = array($params['domain_id']); |
407 | } | |
408 | return $domains; | |
409 | } |