Merge pull request #4556 from jitendrapurohit/CRM-15586
[civicrm-core.git] / api / v3 / examples / Setting / GetFields.php
CommitLineData
6a488035 1<?php
fb32de45 2/**
3 * Test Generated example of using setting getfields API
4 * Demonstrate return from getfields - see subfolder for variants *
6a488035
TO
5 */
6function setting_getfields_example(){
fb32de45 7$params = array();
6a488035 8
fb32de45 9try{
10 $result = civicrm_api3('setting', 'getfields', $params);
11}
12catch (CiviCRM_API3_Exception $e) {
13 // handle error here
14 $errorMessage = $e->getMessage();
15 $errorCode = $e->getErrorCode();
16 $errorData = $e->getExtraParams();
17 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
18}
6a488035 19
fb32de45 20return $result;
6a488035
TO
21}
22
fb32de45 23/**
6a488035
TO
24 * Function returns array of result expected from previous function
25 */
26function setting_getfields_expectedresult(){
27
53ca8fd7 28 $expectedResult = array(
6a488035
TO
29 'is_error' => 0,
30 'version' => 3,
89bf81b4 31 'count' => 89,
53ca8fd7 32 'values' => array(
33 'address_standardization_provider' => array(
6a488035
TO
34 'group_name' => 'Address Preferences',
35 'group' => 'address',
36 'name' => 'address_standardization_provider',
37 'type' => 'String',
38 'html_type' => 'Select',
39 'default' => '',
40 'add' => '4.1',
41 'title' => 'Address Standardization Provider.',
42 'is_domain' => 1,
43 'is_contact' => 0,
44 'description' => '',
45 'help_text' => 'CiviCRM includes an optional plugin for interfacing with the United States Postal Services (USPS) Address Standardization web service. You must register to use the USPS service at https://www.usps.com/business/webtools-address-information.htm. If you are approved, they will provide you with a User ID and the URL for the service. Plugins for other address standardization services may be available from 3rd party developers. If installed, they will be included in the drop-down below. ',
46 ),
53ca8fd7 47 'address_standardization_userid' => array(
6a488035
TO
48 'group_name' => 'Address Preferences',
49 'group' => 'address',
50 'name' => 'address_standardization_userid',
51 'type' => 'String',
52 'html_type' => 'Text',
53 'default' => '',
54 'add' => '4.1',
55 'title' => 'Web service user ID',
56 'is_domain' => 1,
57 'is_contact' => 0,
58 'description' => '',
59 'help_text' => '',
60 ),
53ca8fd7 61 'address_standardization_url' => array(
6a488035
TO
62 'group_name' => 'Address Preferences',
63 'group' => 'address',
64 'name' => 'address_standardization_url',
65 'type' => 'Text',
66 'html_type' => 'Text',
67 'default' => '',
68 'add' => '4.1',
fc3f8a5c 69 'title' => 'Web Service URL',
6a488035
TO
70 'is_domain' => 1,
71 'is_contact' => 0,
72 'description' => '',
fc3f8a5c 73 'help_text' => 'Web Service URL',
6a488035
TO
74 'validate_callback' => 'CRM_Utils_Rule::url',
75 ),
53ca8fd7 76 'tag_unconfirmed' => array(
6a488035
TO
77 'group_name' => 'Campaign Preferences',
78 'group' => 'campaign',
79 'name' => 'tag_unconfirmed',
80 'type' => 'String',
81 'html_type' => 'Text',
82 'default' => 'Unconfirmed',
83 'add' => '4.1',
84 'title' => 'Tag for Unconfirmed Petition Signers',
85 'is_domain' => 1,
86 'is_contact' => 0,
87 'description' => '',
88 'help_text' => 'If set, new contacts that are created when signing a petition are assigned a tag of this name.',
89 ),
53ca8fd7 90 'petition_contacts' => array(
6a488035
TO
91 'group_name' => 'Campaign Preferences',
92 'group' => 'campaign',
93 'name' => 'petition_contacts',
94 'type' => 'String',
95 'html_type' => 'Text',
96 'default' => 'Petition Contacts',
97 'add' => '4.1',
98 'title' => 'Petition Signers Group',
99 'is_domain' => 1,
100 'is_contact' => 0,
101 'description' => '',
102 'help_text' => 'If set, new contacts that are created when signing a petition are assigned a tag of this name.',
103 ),
53ca8fd7 104 'cvv_backoffice_required' => array(
6a488035
TO
105 'group_name' => 'Contribute Preferences',
106 'group' => 'contribute',
107 'name' => 'cvv_backoffice_required',
108 'type' => 'Boolean',
109 'quick_form_type' => 'YesNo',
110 'default' => '1',
111 'add' => '4.1',
112 'title' => 'CVV required for backoffice?',
113 'is_domain' => 1,
114 'is_contact' => 0,
115 'description' => 'Is the CVV code required for back office credit card transactions',
116 'help_text' => 'If set it back-office credit card transactions will required a cvv code. Leave as required unless you have a very strong reason to change',
117 ),
53ca8fd7 118 'contact_view_options' => array(
6a488035
TO
119 'group_name' => 'CiviCRM Preferences',
120 'group' => 'core',
121 'name' => 'contact_view_options',
122 'type' => 'String',
123 'html_type' => 'checkboxes',
53ca8fd7 124 'pseudoconstant' => array(
6a488035
TO
125 'optionGroupName' => 'contact_view_options',
126 ),
53ca8fd7 127 'default' => array(
6a488035
TO
128 '0' => '1',
129 '1' => '2',
130 '2' => '3',
131 '3' => '4',
132 '4' => '5',
133 '5' => '6',
134 '6' => '7',
135 '7' => '8',
136 '8' => '9',
137 '9' => '10',
138 '10' => '11',
139 '11' => '13',
140 ),
141 'add' => '4.1',
142 'title' => 'Viewing Contacts',
143 'is_domain' => '1',
144 'is_contact' => 0,
145 'description' => '',
146 'help_text' => '',
147 ),
53ca8fd7 148 'contact_edit_options' => array(
6a488035
TO
149 'group_name' => 'CiviCRM Preferences',
150 'group' => 'core',
151 'name' => 'contact_edit_options',
152 'type' => 'String',
153 'html_type' => 'checkboxes',
53ca8fd7 154 'pseudoconstant' => array(
6a488035
TO
155 'optionGroupName' => 'contact_edit_options',
156 ),
53ca8fd7 157 'default' => array(
6a488035
TO
158 '0' => '1',
159 '1' => '2',
160 '2' => '3',
161 '3' => '4',
162 '4' => '5',
163 '5' => '6',
164 '6' => '7',
165 '7' => '8',
166 '8' => '9',
167 '9' => '10',
168 '10' => '11',
169 ),
170 'add' => '4.1',
171 'title' => 'Editing Contacts',
172 'is_domain' => 1,
173 'is_contact' => 0,
174 'description' => '',
175 'help_text' => '',
176 ),
53ca8fd7 177 'advanced_search_options' => array(
6a488035
TO
178 'group_name' => 'CiviCRM Preferences',
179 'name' => 'advanced_search_options',
180 'type' => 'String',
181 'html_type' => 'checkboxes',
53ca8fd7 182 'pseudoconstant' => array(
6a488035
TO
183 'optionGroupName' => 'advanced_search_options',
184 ),
53ca8fd7 185 'default' => array(
6a488035
TO
186 '0' => '1',
187 '1' => '2',
188 '2' => '3',
189 '3' => '4',
190 '4' => '5',
191 '5' => '6',
192 '6' => '7',
193 '7' => '8',
194 '8' => '9',
195 '9' => '10',
196 '10' => '12',
197 '11' => '13',
198 '12' => '15',
199 '13' => '16',
200 '14' => '17',
201 '15' => '18',
202 '16' => '19',
203 ),
204 'add' => '4.1',
205 'title' => 'Contact Search',
206 'is_domain' => 1,
207 'is_contact' => 0,
208 'description' => '',
209 'help_text' => '',
210 ),
53ca8fd7 211 'user_dashboard_options' => array(
6a488035
TO
212 'group_name' => 'CiviCRM Preferences',
213 'group' => 'core',
214 'name' => 'user_dashboard_options',
215 'type' => 'String',
216 'html_type' => 'checkboxes',
53ca8fd7 217 'pseudoconstant' => array(
6a488035
TO
218 'optionGroupName' => 'user_dashboard_options',
219 ),
53ca8fd7 220 'default' => array(
6a488035
TO
221 '0' => '1',
222 '1' => '2',
223 '2' => '3',
224 '3' => '4',
225 '4' => '5',
226 '5' => '7',
227 '6' => '8',
228 '7' => '9',
229 ),
230 'add' => '4.1',
231 'title' => 'Contact Dashboard',
232 'is_domain' => 1,
233 'is_contact' => 0,
234 'description' => '',
235 'help_text' => '',
236 ),
53ca8fd7 237 'address_options' => array(
6a488035
TO
238 'group_name' => 'CiviCRM Preferences',
239 'group' => 'core',
240 'name' => 'address_options',
241 'type' => 'String',
242 'html_type' => 'Text',
53ca8fd7 243 'pseudoconstant' => array(
6a488035
TO
244 'optionGroupName' => 'address_options',
245 ),
53ca8fd7 246 'default' => array(
6a488035
TO
247 '0' => '1',
248 '1' => '2',
249 '2' => '4',
250 '3' => '5',
251 '4' => '8',
252 '5' => '9',
253 '6' => '10',
254 '7' => '11',
255 ),
256 'add' => '4.1',
257 'title' => 'Addressing Options',
258 'is_domain' => 1,
259 'is_contact' => 0,
260 'description' => '',
261 'help_text' => '',
262 ),
53ca8fd7 263 'address_format' => array(
6a488035
TO
264 'group_name' => 'CiviCRM Preferences',
265 'group' => 'core',
266 'name' => 'address_format',
267 'type' => 'String',
24e06789 268 'html_type' => 'TextArea',
6a488035
TO
269 'default' => '{contact.address_name}
270{contact.street_address}
271{contact.supplemental_address_1}
272{contact.supplemental_address_2}
273{contact.city}{, }{contact.state_province}{ }{contact.postal_code}
274{contact.country}',
275 'add' => '4.1',
276 'title' => 'Address Format',
277 'is_domain' => 1,
278 'is_contact' => 0,
279 'description' => '',
280 'help_text' => '',
281 ),
53ca8fd7 282 'mailing_format' => array(
6a488035
TO
283 'group_name' => 'CiviCRM Preferences',
284 'group' => 'core',
285 'name' => 'mailing_format',
286 'type' => 'String',
287 'html_type' => 'Text',
288 'default' => '{contact.addressee}
289{contact.street_address}
290{contact.supplemental_address_1}
291{contact.supplemental_address_2}
292{contact.city}{, }{contact.state_province}{ }{contact.postal_code}
293{contact.country}',
294 'add' => '4.1',
295 'title' => 'Mailing Format',
296 'is_domain' => 1,
297 'is_contact' => 0,
298 'description' => '',
299 'help_text' => '',
300 ),
53ca8fd7 301 'display_name_format' => array(
6a488035
TO
302 'group_name' => 'CiviCRM Preferences',
303 'group' => 'core',
304 'name' => 'display_name_format',
305 'type' => 'String',
306 'html_type' => 'Text',
307 'default' => '{contact.individual_prefix}{ }{contact.first_name}{ }{contact.last_name}{ }{contact.individual_suffix}',
308 'add' => '4.1',
309 'title' => 'Display Name Format',
310 'is_domain' => 1,
311 'is_contact' => 0,
312 'description' => '',
313 'help_text' => '',
314 ),
53ca8fd7 315 'sort_name_format' => array(
6a488035
TO
316 'group_name' => 'CiviCRM Preferences',
317 'group' => 'core',
318 'name' => 'sort_name_format',
319 'type' => 'String',
320 'html_type' => 'Text',
321 'default' => '{contact.last_name}{, }{contact.first_name}',
322 'add' => '4.1',
89bf81b4 323 'title' => 'Sort Name Format',
6a488035
TO
324 'is_domain' => 1,
325 'is_contact' => 0,
326 'description' => '',
327 'help_text' => '',
328 ),
53ca8fd7 329 'editor_id' => array(
6a488035
TO
330 'group_name' => 'CiviCRM Preferences',
331 'group' => 'core',
332 'name' => 'editor_id',
333 'type' => 'String',
334 'html_type' => 'Text',
335 'default' => '',
336 'add' => '4.1',
89bf81b4 337 'title' => 'Wysiwig Editor',
6a488035
TO
338 'is_domain' => 1,
339 'is_contact' => 0,
340 'description' => '',
341 'help_text' => '',
342 ),
53ca8fd7 343 'contact_ajax_check_similar' => array(
6a488035
TO
344 'group_name' => 'CiviCRM Preferences',
345 'group' => 'core',
346 'name' => 'contact_ajax_check_similar',
347 'type' => 'String',
348 'html_type' => 'Text',
349 'default' => '',
350 'add' => '4.1',
89bf81b4 351 'title' => 'Ajax Check Similar',
352 'is_domain' => 1,
353 'is_contact' => 0,
354 'description' => '',
355 'help_text' => '',
356 ),
357 'ajaxPopupsEnabled' => array(
358 'group_name' => 'CiviCRM Preferences',
359 'group' => 'core',
360 'name' => 'ajaxPopupsEnabled',
361 'type' => 'Boolean',
362 'quick_form_type' => 'YesNo',
363 'default' => 1,
364 'add' => '4.5',
365 'title' => 'Ajax Popups Enabled',
6a488035
TO
366 'is_domain' => 1,
367 'is_contact' => 0,
368 'description' => '',
369 'help_text' => '',
370 ),
53ca8fd7 371 'activity_assignee_notification' => array(
6a488035
TO
372 'group_name' => 'CiviCRM Preferences',
373 'group' => 'core',
374 'name' => 'activity_assignee_notification',
375 'type' => 'String',
376 'html_type' => 'Text',
377 'default' => '',
378 'add' => '4.1',
379 'title' => 'Notify Activity Assignees',
380 'is_domain' => 1,
381 'is_contact' => 0,
382 'description' => '',
383 'help_text' => '',
384 ),
53ca8fd7 385 'activity_assignee_notification_ics' => array(
6a488035
TO
386 'group_name' => 'CiviCRM Preferences',
387 'group' => 'core',
388 'name' => 'activity_assignee_notification_ics',
389 'type' => 'String',
390 'html_type' => 'Text',
391 'default' => '',
392 'add' => '4.3',
393 'title' => 'Include ICal Invite to Activity Assignees',
394 'is_domain' => 1,
395 'is_contact' => 0,
396 'description' => '',
397 'help_text' => '',
398 ),
53ca8fd7 399 'contact_autocomplete_options' => array(
6a488035
TO
400 'group_name' => 'CiviCRM Preferences',
401 'group' => 'core',
402 'name' => 'contact_autocomplete_options',
403 'type' => 'String',
404 'html_type' => 'checkboxes',
53ca8fd7 405 'pseudoconstant' => array(
24e06789 406 'optionGroupName' => 'contact_autocomplete_options',
407 ),
53ca8fd7 408 'default' => array(
6a488035
TO
409 '0' => '1',
410 '1' => '2',
411 '2' => '3',
412 '3' => '4',
413 '4' => '5',
414 '5' => '6',
415 '6' => '7',
416 ),
417 'add' => '4.1',
418 'title' => 'Contact Reference Autocomplete Options',
419 'is_domain' => 1,
420 'is_contact' => 0,
421 'description' => '',
422 'help_text' => '',
423 ),
53ca8fd7 424 'contact_reference_options' => array(
6a488035
TO
425 'group_name' => 'CiviCRM Preferences',
426 'group' => 'core',
427 'name' => 'contact_reference_options',
428 'type' => 'String',
429 'html_type' => 'checkboxes',
53ca8fd7 430 'pseudoconstant' => array(
6a488035
TO
431 'optionGroupName' => 'contact_reference_options',
432 ),
53ca8fd7 433 'default' => array(
6a488035
TO
434 '0' => '1',
435 '1' => '2',
436 '2' => '3',
437 '3' => '4',
438 '4' => '5',
439 '5' => '6',
440 '6' => '7',
441 ),
442 'add' => '4.1',
89bf81b4 443 'title' => 'Contact Reference Options',
6a488035
TO
444 'is_domain' => 1,
445 'is_contact' => 0,
446 'description' => '',
447 'help_text' => '',
448 ),
53ca8fd7 449 'max_attachments' => array(
6a488035
TO
450 'group_name' => 'CiviCRM Preferences',
451 'group' => 'core',
452 'name' => 'max_attachments',
453 'legacy_key' => 'maxAttachments',
454 'prefetch' => 0,
455 'type' => 'Integer',
456 'quick_form_type' => 'Element',
457 'html_type' => 'text',
53ca8fd7 458 'html_attributes' => array(
6a488035
TO
459 'size' => 2,
460 'maxlength' => 8,
461 ),
462 'default' => 3,
463 'add' => '4.3',
464 'title' => 'Maximum Attachments',
465 'is_domain' => 1,
466 'is_contact' => 0,
467 'description' => 'Maximum number of files (documents, images, etc.) which can attached to emails or activities.',
468 'help_text' => '',
469 ),
53ca8fd7 470 'maxFileSize' => array(
6a488035
TO
471 'group_name' => 'CiviCRM Preferences',
472 'group' => 'core',
473 'name' => 'maxFileSize',
474 'prefetch' => 1,
475 'config_only' => 1,
476 'type' => 'Integer',
477 'quick_form_type' => 'Element',
478 'html_type' => 'text',
53ca8fd7 479 'html_attributes' => array(
6a488035
TO
480 'size' => 2,
481 'maxlength' => 8,
482 ),
483 'default' => 3,
484 'add' => '4.3',
485 'title' => 'Maximum File Size (in MB)',
486 'is_domain' => 1,
487 'is_contact' => 0,
488 'description' => 'Maximum Size of file (documents, images, etc.) which can attached to emails or activities.<br />Note: php.ini should support this file size.',
489 'help_text' => '',
490 ),
53ca8fd7 491 'contact_undelete' => array(
6a488035
TO
492 'group_name' => 'CiviCRM Preferences',
493 'group' => 'core',
494 'name' => 'contact_undelete',
495 'type' => 'Boolean',
496 'quick_form_type' => 'YesNo',
497 'default' => 1,
498 'add' => '4.3',
499 'title' => 'Contact Trash and Undelete',
500 'is_domain' => 1,
501 'is_contact' => 0,
502 'description' => 'If enabled, deleted contacts will be moved to trash (instead of being destroyed). Users with the proper permission are able to search for the deleted contacts and restore them (or delete permanently).',
503 'help_text' => '',
504 ),
fb32de45 505 'allowPermDeleteFinancial' => array(
506 'group_name' => 'CiviCRM Preferences',
507 'group' => 'core',
508 'name' => 'allowPermDeleteFinancial',
509 'type' => 'Boolean',
510 'quick_form_type' => 'YesNo',
511 'default' => '',
512 'add' => '4.3',
513 'title' => 'Contact Permanent Delete',
514 'is_domain' => 1,
515 'is_contact' => 0,
516 'description' => 'Allow Permanent Delete for contacts who are linked to live financial transactions',
517 'help_text' => '',
518 ),
53ca8fd7 519 'versionAlert' => array(
520 'group_name' => 'CiviCRM Preferences',
521 'group' => 'core',
522 'name' => 'versionAlert',
523 'type' => 'Boolean',
524 'quick_form_type' => 'YesNo',
525 'default' => 1,
526 'add' => '4.3',
527 'title' => 'New Version Alerts',
528 'is_domain' => 1,
529 'is_contact' => 0,
b25fe59a 530 'description' => 'Displays an on-screen alert to users with \"Administer CiviCRM\" permissions when a new version of CiviCRM is available. This setting will only work if the \"Version Check & Statistics Reporting\" setting is enabled.',
53ca8fd7 531 'help_text' => '',
532 ),
533 'versionCheck' => array(
6a488035
TO
534 'group_name' => 'CiviCRM Preferences',
535 'group' => 'core',
536 'name' => 'versionCheck',
537 'prefetch' => 1,
538 'config_only' => 1,
539 'type' => 'Boolean',
540 'quick_form_type' => 'YesNo',
541 'default' => 1,
542 'add' => '4.3',
543 'title' => 'Version Check & Statistics Reporting',
544 'is_domain' => 1,
545 'is_contact' => 0,
546 'description' => 'If enabled, CiviCRM automatically checks availablity of a newer version of the software. New version alerts will be displayed on the main CiviCRM Administration page.
547When enabled, statistics about your CiviCRM installation are reported anonymously to the CiviCRM team to assist in prioritizing ongoing development efforts. The following information is gathered: CiviCRM version, versions of PHP, MySQL and framework (Drupal/Joomla/standalone), and default language. Counts (but no actual data) of the following record types are reported: contacts, activities, cases, relationships, contributions, contribution pages, contribution products, contribution widgets, discounts, price sets, profiles, events, participants, tell-a-friend pages, grants, mailings, memberships, membership blocks, pledges, pledge blocks and active payment processor types.',
548 'help_text' => '',
549 ),
89bf81b4 550 'securityAlert' => array(
551 'group_name' => 'CiviCRM Preferences',
552 'group' => 'core',
553 'name' => 'versionCheck',
554 'prefetch' => 0,
555 'type' => 'Boolean',
556 'quick_form_type' => 'YesNo',
557 'default' => 1,
558 'add' => '4.4',
559 'title' => 'Security Alerts',
560 'is_domain' => 1,
561 'is_contact' => 0,
562 'description' => 'If enabled, CiviCRM will automatically run checks for significant mis-configurations such as ineffective file protections.',
563 'help_text' => '',
564 ),
53ca8fd7 565 'doNotAttachPDFReceipt' => array(
6a488035
TO
566 'group_name' => 'CiviCRM Preferences',
567 'group' => 'core',
568 'name' => 'doNotAttachPDFReceipt',
569 'prefetch' => 1,
570 'config_only' => 1,
571 'type' => 'Boolean',
572 'quick_form_type' => 'YesNo',
573 'default' => 1,
574 'add' => '4.3',
575 'title' => 'Attach PDF copy to receipts',
576 'is_domain' => 1,
577 'is_contact' => 0,
578 'description' => 'If enabled, CiviCRM sends PDF receipt as an attachment during event signup or online contribution.',
579 'help_text' => '',
580 ),
53ca8fd7 581 'wkhtmltopdfPath' => array(
6a488035
TO
582 'group_name' => 'CiviCRM Preferences',
583 'group' => 'core',
584 'name' => 'wkhtmltopdfPath',
585 'prefetch' => 1,
586 'config_only' => 1,
587 'type' => 'String',
588 'quick_form_type' => 'Element',
589 'html_type' => 'Text',
53ca8fd7 590 'html_attributes' => array(
6a488035
TO
591 'size' => 64,
592 'maxlength' => 256,
593 ),
594 'default' => '',
595 'add' => '4.3',
596 'title' => 'Path to wkhtmltopdf executable',
597 'is_domain' => 1,
598 'is_contact' => 0,
599 'description' => '',
600 'help_text' => '',
601 ),
53ca8fd7 602 'recaptchaPublicKey' => array(
6a488035
TO
603 'group_name' => 'CiviCRM Preferences',
604 'group' => 'core',
605 'name' => 'recaptchaPublicKey',
606 'prefetch' => 1,
607 'config_only' => 1,
608 'type' => 'String',
609 'quick_form_type' => 'Element',
610 'html_type' => 'Text',
53ca8fd7 611 'html_attributes' => array(
6a488035
TO
612 'size' => 64,
613 'maxlength' => 64,
614 ),
615 'default' => '',
616 'add' => '4.3',
617 'title' => 'Recaptcha Public Key',
618 'is_domain' => 1,
619 'is_contact' => 0,
620 'description' => '',
621 'help_text' => '',
622 ),
53ca8fd7 623 'recaptchaPrivateKey' => array(
6a488035
TO
624 'group_name' => 'CiviCRM Preferences',
625 'group' => 'core',
626 'name' => 'recaptchaPrivateKey',
627 'prefetch' => 1,
628 'config_only' => 1,
629 'type' => 'String',
630 'quick_form_type' => 'Element',
631 'html_type' => 'Text',
53ca8fd7 632 'html_attributes' => array(
6a488035
TO
633 'size' => 64,
634 'maxlength' => 64,
635 ),
636 'default' => '',
637 'add' => '4.3',
638 'title' => 'Recaptcha Private Key',
639 'is_domain' => 1,
640 'is_contact' => 0,
641 'description' => '',
642 'help_text' => '',
643 ),
53ca8fd7 644 'dashboardCacheTimeout' => array(
6a488035
TO
645 'group_name' => 'CiviCRM Preferences',
646 'group' => 'core',
647 'name' => 'dashboardCacheTimeout',
648 'prefetch' => 1,
649 'config_only' => 1,
650 'type' => 'Integer',
651 'quick_form_type' => 'Element',
652 'html_type' => 'Text',
53ca8fd7 653 'html_attributes' => array(
6a488035
TO
654 'size' => 3,
655 'maxlength' => 5,
656 ),
657 'default' => '',
658 'add' => '4.3',
659 'title' => 'Dashboard cache timeout',
660 'is_domain' => 1,
661 'is_contact' => 0,
662 'description' => '',
663 'help_text' => '',
664 ),
53ca8fd7 665 'checksumTimeout' => array(
6a488035
TO
666 'group_name' => 'CiviCRM Preferences',
667 'group' => 'core',
668 'name' => 'checksumTimeout',
669 'prefetch' => 1,
6a488035
TO
670 'type' => 'Integer',
671 'quick_form_type' => 'Element',
672 'html_type' => 'Text',
53ca8fd7 673 'html_attributes' => array(
6a488035
TO
674 'size' => 2,
675 'maxlength' => 8,
676 ),
677 'default' => 7,
678 'add' => '4.3',
fb32de45 679 'title' => 'Checksum Lifespan',
6a488035
TO
680 'is_domain' => 1,
681 'is_contact' => 0,
682 'description' => '',
683 'help_text' => '',
684 ),
4ed37178
E
685 'blogUrl' => array(
686 'group_name' => 'CiviCRM Preferences',
687 'group' => 'core',
688 'name' => 'blogUrl',
689 'prefetch' => 0,
4ed37178
E
690 'type' => 'String',
691 'quick_form_type' => 'Element',
692 'html_type' => 'Text',
693 'html_attributes' => array(
694 'size' => 64,
695 'maxlength' => 128,
696 ),
697 'default' => '*default*',
698 'add' => '4.3',
699 'title' => 'Blog Feed URL',
700 'is_domain' => 1,
701 'is_contact' => 0,
702 'description' => 'Blog feed URL used by the blog dashlet',
703 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
704 ),
53ca8fd7 705 'communityMessagesUrl' => array(
24e06789 706 'group_name' => 'CiviCRM Preferences',
707 'group' => 'core',
708 'name' => 'communityMessagesUrl',
709 'prefetch' => 0,
24e06789 710 'type' => 'String',
711 'quick_form_type' => 'Element',
712 'html_type' => 'Text',
53ca8fd7 713 'html_attributes' => array(
24e06789 714 'size' => 64,
715 'maxlength' => 128,
716 ),
717 'default' => '*default*',
718 'add' => '4.3',
719 'title' => 'Community Messages URL',
720 'is_domain' => 1,
721 'is_contact' => 0,
722 'description' => 'Service providing CiviCRM community messages',
b25fe59a 723 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
24e06789 724 ),
53ca8fd7 725 'resCacheCode' => array(
6a488035
TO
726 'group_name' => 'CiviCRM Preferences',
727 'group' => 'core',
728 'name' => 'resCacheCode',
729 'prefetch' => 1,
730 'config_only' => 1,
731 'type' => 'String',
732 'quick_form_type' => 'Element',
733 'html_type' => 'Text',
53ca8fd7 734 'html_attributes' => array(
6a488035
TO
735 'size' => 16,
736 'maxlength' => 16,
737 ),
738 'default' => '',
739 'add' => '4.3',
740 'title' => 'Resource Cache Code',
741 'is_domain' => 1,
742 'is_contact' => 0,
743 'description' => 'Code appended to resource URLs (JS/CSS) to coerce HTTP caching',
744 'help_text' => '',
745 ),
53ca8fd7 746 'verifySSL' => array(
6a488035
TO
747 'group_name' => 'CiviCRM Preferences',
748 'group' => 'core',
749 'name' => 'verifySSL',
750 'type' => 'Boolean',
751 'quick_form_type' => 'YesNo',
752 'default' => 1,
753 'add' => '4.3',
89bf81b4 754 'title' => 'Verify SSL?',
6a488035
TO
755 'is_domain' => 1,
756 'is_contact' => 0,
757 'description' => 'If disabled, backend HTTPS services will allow unverified, insecure connections',
758 'help_text' => 'Unless you are absolutely unable to configure your server to check the SSL certificate of the remote server you should leave this set to Yes',
759 ),
53ca8fd7 760 'wpBasePage' => array(
761 'group_name' => 'CiviCRM Preferences',
762 'group' => 'core',
763 'name' => 'wpBasePage',
764 'type' => 'String',
765 'html_type' => 'text',
766 'quick_form_type' => 'Element',
767 'prefetch' => 1,
768 'default' => '',
769 'add' => '4.3',
770 'title' => 'WordPress Base Page',
771 'is_domain' => 1,
772 'is_contact' => 0,
773 'description' => 'If set, CiviCRM will use this setting as the base url.',
774 'help_text' => 'By default, CiviCRM will generate front-facing pages using the home page at http://wp/ as its base. If you want to use a different template for CiviCRM pages, set the path here.',
775 ),
d5f1ee75 776 'secondDegRelPermissions' => array(
fb32de45 777 'group_name' => 'CiviCRM Preferences',
778 'group' => 'core',
779 'name' => 'secondDegRelPermissions',
780 'prefetch' => 1,
fb32de45 781 'type' => 'Boolean',
782 'quick_form_type' => 'YesNo',
783 'default' => 0,
784 'add' => '4.3',
785 'title' => 'Allow second-degree relationship permissions',
786 'is_domain' => 1,
787 'is_contact' => 0,
b25fe59a 788 'description' => 'If enabled, contacts with the permission to edit a related contact will inherit that contact\'s permission to edit other related contacts',
fb32de45 789 'help_text' => '',
790 ),
791 'enable_components' => array(
792 'group_name' => 'CiviCRM Preferences',
793 'group' => 'core',
794 'name' => 'enable_components',
795 'type' => 'Array',
796 'quick_form_type' => 'Element',
797 'html_type' => 'advmultiselect',
798 'html_attributes' => array(
799 'size' => 5,
800 'style' => 'width:150px',
801 'class' => 'advmultiselect',
802 ),
803 'default' => array(
804 '0' => 'CiviEvent',
805 '1' => 'CiviContribute',
806 '2' => 'CiviMember',
807 '3' => 'CiviMail',
808 '4' => 'CiviReport',
809 '5' => 'CiviPledge',
810 ),
811 'add' => '4.4',
812 'title' => 'Enable Components',
813 'is_domain' => '1',
814 'is_contact' => 0,
815 'description' => '',
816 'help_text' => '',
4ed37178
E
817 'on_change' => array(
818 '0' => array(
819 '0' => 'CRM_Case_Info',
820 '1' => 'onToggleComponents',
821 ),
822 '1' => array(
823 '0' => 'CRM_Core_Component',
824 '1' => 'flushEnabledComponents',
825 ),
826 ),
fb32de45 827 ),
b25fe59a
E
828 'disable_core_css' => array(
829 'group_name' => 'CiviCRM Preferences',
830 'group' => 'core',
831 'name' => 'disable_core_css',
832 'type' => 'Boolean',
833 'quick_form_type' => 'YesNo',
834 'default' => 0,
835 'add' => '4.4',
836 'title' => 'Disable CiviCRM css',
837 'is_domain' => 1,
838 'is_contact' => 0,
839 'description' => 'Prevent the stylesheet \"civicrm.css\" from being loaded.',
840 'help_text' => '',
841 ),
466913fc
AH
842 'empoweredBy' => array(
843 'group_name' => 'CiviCRM Preferences',
844 'group' => 'core',
845 'name' => 'empoweredBy',
89bf81b4 846 'prefetch' => 1,
466913fc
AH
847 'type' => 'Boolean',
848 'quick_form_type' => 'YesNo',
849 'default' => 1,
850 'add' => '4.5',
89bf81b4 851 'title' => 'Display \"empowered by CiviCRM\"',
466913fc
AH
852 'is_domain' => 1,
853 'is_contact' => 0,
89bf81b4 854 'description' => 'When enabled, \"empowered by CiviCRM\" is displayed at the bottom of public forms.',
466913fc
AH
855 'help_text' => '',
856 ),
53ca8fd7 857 'debug_enabled' => array(
6a488035
TO
858 'group_name' => 'Developer Preferences',
859 'group' => 'developer',
860 'name' => 'debug_enabled',
6a488035
TO
861 'config_key' => 'debug',
862 'type' => 'Boolean',
863 'quick_form_type' => 'YesNo',
864 'default' => 0,
865 'add' => '4.3',
866 'title' => 'Enable Debugging',
867 'is_domain' => 1,
868 'is_contact' => 0,
b25fe59a 869 'description' => 'Set this value to Yes if you want to use one of CiviCRM\'s debugging tools. This feature should NOT be enabled for production sites',
6a488035
TO
870 'prefetch' => 1,
871 'help_text' => 'Do not turn this on on production sites',
872 ),
53ca8fd7 873 'userFrameworkLogging' => array(
6a488035
TO
874 'group_name' => 'Developer Preferences',
875 'group' => 'developer',
876 'name' => 'userFrameworkLogging',
6a488035
TO
877 'type' => 'Boolean',
878 'quick_form_type' => 'YesNo',
879 'default' => 0,
880 'add' => '4.3',
881 'title' => 'Enable Drupal Watchdog Logging',
882 'is_domain' => 1,
883 'is_contact' => 0,
884 'description' => 'Set this value to Yes if you want CiviCRM error/debugging messages to also appear in Drupal error logs',
885 'prefetch' => 1,
b25fe59a
E
886 'help_text' => 'Set this value to Yes if you want CiviCRM error/debugging messages the appear in your CMS\' error log.
887In the case of Drupal, this will cause all CiviCRM error messages to appear in the watchdog (assuming you have Drupal\'s watchdog enabled)',
6a488035 888 ),
53ca8fd7 889 'backtrace' => array(
6a488035
TO
890 'group_name' => 'Developer Preferences',
891 'group' => 'developer',
892 'name' => 'backtrace',
6a488035
TO
893 'type' => 'Boolean',
894 'quick_form_type' => 'YesNo',
895 'default' => 0,
896 'add' => '4.3',
897 'title' => 'Display Backtrace',
898 'is_domain' => 1,
899 'is_contact' => 0,
900 'description' => 'Set this value to Yes if you want to display a backtrace listing when a fatal error is encountered. This feature should NOT be enabled for production sites',
901 'prefetch' => 1,
902 ),
53ca8fd7 903 'fatalErrorTemplate' => array(
6a488035
TO
904 'group_name' => 'Developer Preferences',
905 'group' => 'developer',
906 'name' => 'fatalErrorTemplate',
6a488035 907 'type' => 'String',
89bf81b4 908 'quick_form_type' => 'Element',
909 'html_type' => 'text',
6a488035
TO
910 'default' => 'CRM/common/fatal.tpl',
911 'add' => '4.3',
912 'title' => 'Fatal Error Template',
913 'is_domain' => 1,
914 'is_contact' => 0,
915 'description' => 'Enter the path and filename for a custom Smarty template if you want to define your own screen for displaying fatal errors.',
916 'prefetch' => 1,
917 ),
53ca8fd7 918 'fatalErrorHandler' => array(
6a488035
TO
919 'group_name' => 'Developer Preferences',
920 'group' => 'developer',
921 'name' => 'fatalErrorHandler',
6a488035 922 'type' => 'String',
89bf81b4 923 'quick_form_type' => 'Element',
924 'html_type' => 'text',
925 'default' => '',
6a488035
TO
926 'add' => '4.3',
927 'title' => 'Fatal Error Handler',
928 'is_domain' => 1,
929 'is_contact' => 0,
930 'description' => 'Enter the path and class for a custom PHP error-handling function if you want to override built-in CiviCRM error handling for your site.',
931 'prefetch' => 1,
932 ),
53ca8fd7 933 'uploadDir' => array(
6a488035
TO
934 'group_name' => 'Directory Preferences',
935 'group' => 'directory',
936 'name' => 'uploadDir',
937 'type' => 'Url',
938 'html_type' => 'Text',
939 'default' => '',
940 'add' => '4.1',
941 'prefetch' => 1,
89bf81b4 942 'title' => 'Upload Directory',
6a488035
TO
943 'is_domain' => 1,
944 'is_contact' => 0,
945 'description' => '',
89bf81b4 946 'help_text' => '',
6a488035 947 ),
53ca8fd7 948 'imageUploadDir' => array(
6a488035
TO
949 'group_name' => 'Directory Preferences',
950 'group' => 'directory',
951 'name' => 'imageUploadDir',
952 'type' => 'Url',
953 'html_type' => 'Text',
954 'default' => '',
955 'add' => '4.1',
956 'prefetch' => 1,
89bf81b4 957 'title' => 'Image Directory',
6a488035
TO
958 'is_domain' => 1,
959 'is_contact' => 0,
960 'description' => '',
961 'help_text' => '',
962 ),
53ca8fd7 963 'customFileUploadDir' => array(
6a488035
TO
964 'group_name' => 'Directory Preferences',
965 'group' => 'directory',
966 'name' => 'customFileUploadDir',
967 'type' => 'Url',
968 'html_type' => 'Text',
969 'default' => '',
970 'add' => '4.1',
971 'prefetch' => 1,
89bf81b4 972 'title' => 'Custom Files Upload Directory',
6a488035
TO
973 'is_domain' => 1,
974 'is_contact' => 0,
975 'description' => '',
976 'help_text' => '',
977 ),
53ca8fd7 978 'customTemplateDir' => array(
6a488035
TO
979 'group_name' => 'Directory Preferences',
980 'group' => 'directory',
981 'name' => 'customTemplateDir',
982 'type' => 'Url',
983 'html_type' => 'Text',
984 'default' => '',
985 'add' => '4.1',
986 'prefetch' => 1,
89bf81b4 987 'title' => 'Custom Template Directory',
6a488035
TO
988 'is_domain' => 1,
989 'is_contact' => 0,
990 'description' => '',
991 'help_text' => '',
992 ),
53ca8fd7 993 'customPHPPathDir' => array(
6a488035
TO
994 'group_name' => 'Directory Preferences',
995 'group' => 'directory',
996 'name' => 'customPHPPathDir',
997 'type' => 'Url',
998 'html_type' => 'Text',
999 'default' => '',
1000 'add' => '4.1',
1001 'prefetch' => 1,
89bf81b4 1002 'title' => 'Custom PHP Path',
6a488035
TO
1003 'is_domain' => 1,
1004 'is_contact' => 0,
1005 'description' => '',
1006 'help_text' => '',
1007 ),
53ca8fd7 1008 'extensionsDir' => array(
6a488035
TO
1009 'group_name' => 'Directory Preferences',
1010 'group' => 'directory',
1011 'name' => 'extensionsDir',
1012 'type' => 'Url',
1013 'html_type' => 'Text',
1014 'default' => '',
1015 'add' => '4.1',
1016 'prefetch' => 1,
89bf81b4 1017 'title' => 'Extensions Directory',
6a488035
TO
1018 'is_domain' => 1,
1019 'is_contact' => 0,
1020 'description' => '',
1021 'help_text' => '',
1022 ),
53ca8fd7 1023 'event_enable_cart' => array(
6a488035
TO
1024 'name' => 'enable_cart',
1025 'group_name' => 'Event Preferences',
1026 'group' => 'event',
1027 'type' => 'String',
1028 'quick_form_type' => 'Element',
1029 'default' => 0,
1030 'add' => '4.1',
1031 'title' => 'Enable Event Cart',
1032 'is_domain' => 1,
1033 'is_contact' => 1,
1034 'description' => 'WRITE ME',
1035 'help_text' => 'WRITE ME',
1036 ),
53ca8fd7 1037 'monetaryThousandSeparator' => array(
6a488035
TO
1038 'group_name' => 'Localization Preferences',
1039 'group' => 'localization',
1040 'name' => 'monetaryThousandSeparator',
1041 'prefetch' => 1,
1042 'config_only' => 1,
1043 'type' => 'String',
1044 'quick_form_type' => 'Element',
1045 'html_type' => 'text',
53ca8fd7 1046 'html_attributes' => array(
6a488035
TO
1047 'size' => 2,
1048 ),
1049 'default' => ',',
1050 'add' => '4.3',
1051 'title' => 'Thousands Separator',
1052 'is_domain' => 1,
1053 'is_contact' => 0,
1054 'description' => '',
1055 'help_text' => '',
1056 ),
53ca8fd7 1057 'monetaryDecimalPoint' => array(
6a488035
TO
1058 'group_name' => 'Localization Preferences',
1059 'group' => 'localization',
1060 'name' => 'monetaryDecimalPoint',
1061 'prefetch' => 1,
1062 'config_only' => 1,
1063 'type' => 'String',
1064 'quick_form_type' => 'Element',
1065 'html_type' => 'text',
53ca8fd7 1066 'html_attributes' => array(
6a488035
TO
1067 'size' => 2,
1068 ),
1069 'default' => '.',
1070 'add' => '4.3',
1071 'title' => 'Decimal Delimiter',
1072 'is_domain' => 1,
1073 'is_contact' => 0,
1074 'description' => '',
1075 'help_text' => '',
1076 ),
53ca8fd7 1077 'moneyformat' => array(
6a488035
TO
1078 'group_name' => 'Localization Preferences',
1079 'group' => 'localization',
1080 'name' => 'moneyformat',
1081 'prefetch' => 1,
1082 'config_only' => 1,
1083 'type' => 'String',
1084 'quick_form_type' => 'Element',
1085 'html_type' => 'text',
1086 'default' => '%c %a',
1087 'add' => '4.3',
1088 'title' => 'Monetary Amount Display',
1089 'is_domain' => 1,
1090 'is_contact' => 0,
1091 'description' => '',
1092 'help_text' => '',
1093 ),
53ca8fd7 1094 'moneyvalueformat' => array(
6a488035
TO
1095 'group_name' => 'Localization Preferences',
1096 'group' => 'localization',
1097 'name' => 'moneyvalueformat',
1098 'prefetch' => 1,
1099 'config_only' => 1,
1100 'type' => 'String',
1101 'quick_form_type' => 'Element',
1102 'html_type' => 'text',
1103 'default' => '%!i',
1104 'add' => '4.3',
1105 'title' => 'Monetary Amount Display',
1106 'is_domain' => 1,
1107 'is_contact' => 0,
1108 'description' => '',
1109 'help_text' => '',
1110 ),
53ca8fd7 1111 'defaultCurrency' => array(
6a488035
TO
1112 'group_name' => 'Localization Preferences',
1113 'group' => 'localization',
1114 'name' => 'defaultCurrency',
1115 'prefetch' => 1,
1116 'config_only' => 1,
1117 'type' => 'String',
1118 'quick_form_type' => 'Element',
1119 'html_type' => 'text',
53ca8fd7 1120 'html_attributes' => array(
6a488035
TO
1121 'size' => 2,
1122 ),
1123 'default' => 'USD',
1124 'add' => '4.3',
1125 'title' => 'Default Currency',
1126 'is_domain' => 1,
1127 'is_contact' => 0,
1128 'description' => 'Default currency assigned to contributions and other monetary transactions.',
1129 'help_text' => '',
1130 ),
b25fe59a
E
1131 'defaultContactCountry' => array(
1132 'group_name' => 'Localization Preferences',
1133 'group' => 'localization',
1134 'name' => 'defaultContactCountry',
1135 'prefetch' => 1,
1136 'config_only' => 1,
1137 'type' => 'String',
1138 'quick_form_type' => 'Element',
1139 'html_type' => 'text',
1140 'html_attributes' => array(
1141 'size' => 4,
1142 ),
1143 'default' => '1228',
1144 'add' => '4.4',
1145 'title' => 'Default Country',
1146 'is_domain' => 1,
1147 'is_contact' => 0,
1148 'description' => 'This value is selected by default when adding a new contact address.',
1149 'help_text' => '',
1150 ),
53ca8fd7 1151 'countryLimit' => array(
6a488035
TO
1152 'group_name' => 'Localization Preferences',
1153 'group' => 'localization',
1154 'name' => 'countryLimit',
1155 'prefetch' => 1,
1156 'config_only' => 1,
1157 'type' => 'Array',
1158 'quick_form_type' => 'Element',
1159 'html_type' => 'advmultiselect',
53ca8fd7 1160 'html_attributes' => array(
6a488035
TO
1161 'size' => 5,
1162 'style' => 'width:150px',
1163 'class' => 'advmultiselect',
1164 ),
1165 'default' => 'null',
1166 'add' => '4.3',
1167 'title' => 'Available Countries',
1168 'is_domain' => 1,
1169 'is_contact' => 0,
1170 'description' => '',
1171 'help_text' => '',
1172 ),
53ca8fd7 1173 'provinceLimit' => array(
6a488035
TO
1174 'group_name' => 'Localization Preferences',
1175 'group' => 'localization',
1176 'name' => 'provinceLimit',
1177 'prefetch' => 1,
1178 'config_only' => 1,
1179 'type' => 'Array',
1180 'quick_form_type' => 'Element',
1181 'html_type' => 'advmultiselect',
53ca8fd7 1182 'html_attributes' => array(
6a488035
TO
1183 'size' => 5,
1184 'style' => 'width:150px',
1185 'class' => 'advmultiselect',
1186 ),
1187 'default' => 'null',
1188 'add' => '4.3',
1189 'title' => 'Available States and Provinces',
1190 'is_domain' => 1,
1191 'is_contact' => 0,
1192 'description' => '',
1193 'help_text' => '',
1194 ),
53ca8fd7 1195 'inheritLocale' => array(
6a488035
TO
1196 'group_name' => 'Localization Preferences',
1197 'group' => 'localization',
1198 'name' => 'inheritLocale',
1199 'prefetch' => 1,
1200 'config_only' => 1,
1201 'type' => 'Boolean',
1202 'quick_form_type' => 'YesNo',
1203 'default' => 0,
1204 'add' => '4.3',
1205 'title' => 'Inherit CMS Language',
1206 'is_domain' => 1,
1207 'is_contact' => 0,
1208 'description' => '',
1209 'help_text' => '',
1210 ),
53ca8fd7 1211 'dateformatDatetime' => array(
6a488035
TO
1212 'group_name' => 'Localization Preferences',
1213 'group' => 'localization',
1214 'name' => 'dateformatDatetime',
1215 'prefetch' => 1,
1216 'config_only' => 1,
1217 'type' => 'String',
1218 'default' => '%B %E%f, %Y %l:%M %P',
1219 'add' => '4.3',
1220 'title' => 'Complete Date and Time',
1221 'is_domain' => 1,
1222 'is_contact' => 0,
1223 'description' => '',
1224 'help_text' => '',
1225 ),
53ca8fd7 1226 'dateformatFull' => array(
6a488035
TO
1227 'group_name' => 'Localization Preferences',
1228 'group' => 'localization',
1229 'name' => 'dateformatFull',
1230 'prefetch' => 1,
1231 'config_only' => 1,
1232 'type' => 'String',
1233 'default' => '%B %E%f, %Y',
1234 'add' => '4.3',
1235 'title' => 'Complete Date',
1236 'is_domain' => 1,
1237 'is_contact' => 0,
1238 'description' => '',
1239 'help_text' => '',
1240 ),
53ca8fd7 1241 'dateformatPartial' => array(
6a488035
TO
1242 'group_name' => 'Localization Preferences',
1243 'group' => 'localization',
1244 'name' => 'dateformatPartial',
1245 'prefetch' => 1,
1246 'config_only' => 1,
1247 'type' => 'String',
1248 'default' => '%B %Y',
1249 'add' => '4.3',
1250 'title' => 'Month and Year',
1251 'is_domain' => 1,
1252 'is_contact' => 0,
1253 'description' => '',
1254 'help_text' => '',
1255 ),
53ca8fd7 1256 'lcMessages' => array(
6a488035
TO
1257 'group_name' => 'Localization Preferences',
1258 'group' => 'localization',
1259 'name' => 'lcMessages',
1260 'prefetch' => 1,
1261 'config_only' => 1,
1262 'type' => 'String',
1263 'default' => 'en_US',
1264 'add' => '4.3',
1265 'title' => 'Default Language',
1266 'is_domain' => 1,
1267 'is_contact' => 0,
1268 'description' => '',
1269 'help_text' => '',
1270 ),
53ca8fd7 1271 'profile_double_optin' => array(
6a488035
TO
1272 'group_name' => 'Mailing Preferences',
1273 'group' => 'mailing',
1274 'name' => 'profile_double_optin',
1275 'type' => 'Integer',
1276 'html_type' => 'checkbox',
1277 'default' => 0,
1278 'add' => '4.1',
1279 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1280 'is_domain' => 1,
1281 'is_contact' => 0,
b25fe59a 1282 'description' => 'When CiviMail is enabled, users who \"subscribe\" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.',
6a488035
TO
1283 'help_text' => '',
1284 ),
53ca8fd7 1285 'track_civimail_replies' => array(
6a488035
TO
1286 'group_name' => 'Mailing Preferences',
1287 'group' => 'mailing',
1288 'name' => 'track_civimail_replies',
1289 'type' => 'Integer',
1290 'html_type' => 'checkbox',
1291 'default' => 0,
1292 'add' => '4.1',
1293 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1294 'is_domain' => 1,
1295 'is_contact' => 0,
b25fe59a 1296 'description' => 'When CiviMail is enabled, users who \"subscribe\" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.',
6a488035
TO
1297 'help_text' => '',
1298 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting',
1299 ),
53ca8fd7 1300 'civimail_workflow' => array(
6a488035
TO
1301 'group_name' => 'Mailing Preferences',
1302 'group' => 'mailing',
1303 'name' => 'civimail_workflow',
1304 'type' => 'Integer',
1305 'html_type' => 'checkbox',
1306 'default' => 0,
1307 'add' => '4.1',
89bf81b4 1308 'title' => 'Use CiviMail Workflow',
6a488035
TO
1309 'is_domain' => 1,
1310 'is_contact' => 0,
b25fe59a 1311 'description' => 'When CiviMail is enabled, users who \"subscribe\" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.',
6a488035
TO
1312 'help_text' => '',
1313 ),
53ca8fd7 1314 'civimail_server_wide_lock' => array(
6a488035
TO
1315 'group_name' => 'Mailing Preferences',
1316 'group' => 'mailing',
1317 'name' => 'civimail_server_wide_lock',
1318 'type' => 'Integer',
1319 'html_type' => 'checkbox',
1320 'default' => 0,
1321 'add' => '4.1',
89bf81b4 1322 'title' => 'Lock Mails Server-Wide for Mail Sending',
6a488035
TO
1323 'is_domain' => 1,
1324 'is_contact' => 0,
1325 'description' => '',
1326 'help_text' => '',
1327 ),
53ca8fd7 1328 'mailing_backend' => array(
6a488035
TO
1329 'group_name' => 'Mailing Preferences',
1330 'group' => 'mailing',
1331 'name' => 'mailing_backend',
1332 'type' => 'Array',
1333 'html_type' => 'checkbox',
1334 'default' => 0,
1335 'add' => '4.1',
89bf81b4 1336 'title' => 'Mailing Backend',
6a488035
TO
1337 'is_domain' => 1,
1338 'is_contact' => 0,
1339 'description' => '',
1340 'help_text' => '',
1341 ),
53ca8fd7 1342 'profile_add_to_group_double_optin' => array(
6a488035
TO
1343 'group_name' => 'Mailing Preferences',
1344 'group' => 'mailing',
1345 'name' => 'profile_add_to_group_double_optin',
1346 'type' => 'Integer',
1347 'html_type' => 'checkbox',
1348 'default' => 0,
1349 'add' => '4.1',
1350 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1351 'is_domain' => 1,
1352 'is_contact' => 0,
b25fe59a
E
1353 'description' => 'When CiviMail is enabled, users who \"subscribe\" to a group from a profile Group(s) checkbox will receive a confirmation email. They must respond (opt-in) before they are added to the group.',
1354 'help_text' => '',
1355 ),
1356 'disable_mandatory_tokens_check' => array(
1357 'group_name' => 'Mailing Preferences',
1358 'group' => 'mailing',
1359 'name' => 'disable_mandatory_tokens_check',
1360 'type' => 'Integer',
1361 'html_type' => 'checkbox',
1362 'default' => 0,
1363 'add' => '4.4',
1364 'title' => 'Disable check for mandatory tokens',
1365 'is_domain' => 1,
1366 'is_contact' => 0,
1367 'description' => 'Don\'t check for presence of mandatory tokens (domain address; unsubscribe/opt-out) before sending mailings. WARNING: Mandatory tokens are a safe-guard which facilitate compliance with the US CAN-SPAM Act. They should only be disabled if your organization adopts other mechanisms for compliance or if your organization is not subject to CAN-SPAM.',
6a488035
TO
1368 'help_text' => '',
1369 ),
89bf81b4 1370 'dedupe_email_default' => array(
1371 'group_name' => 'Mailing Preferences',
1372 'group' => 'mailing',
1373 'name' => 'dedupe_email_default',
1374 'type' => 'Integer',
1375 'html_type' => 'checkbox',
1376 'default' => 1,
1377 'add' => '4.5',
1378 'title' => 'CiviMail dedupes e-mail addresses by default',
1379 'is_domain' => 1,
1380 'is_contact' => 0,
1381 'description' => 'Set the \"dedupe e-mail\" option when sending a new mailing to \"true\" by default.',
1382 'help_text' => '',
1383 ),
1384 'hash_mailing_url' => array(
1385 'group_name' => 'Mailing Preferences',
1386 'group' => 'mailing',
1387 'name' => 'hash_mailing_url',
1388 'type' => 'Integer',
1389 'html_type' => 'checkbox',
1390 'default' => 0,
1391 'add' => '4.5',
1392 'title' => 'Hashed Mailing URL\'s',
1393 'is_domain' => 1,
1394 'is_contact' => 0,
1395 'description' => 'If enabled, a randomized hash key will be used to reference the mailing URL in the mailing.viewUrl token, instead of the mailing ID',
1396 'help_text' => '',
1397 ),
53ca8fd7 1398 'default_renewal_contribution_page' => array(
6a488035
TO
1399 'group_name' => 'Member Preferences',
1400 'group' => 'member',
1401 'name' => 'default_renewal_contribution_page',
1402 'type' => 'Integer',
1403 'html_type' => 'Select',
1404 'default' => '',
53ca8fd7 1405 'pseudoconstant' => array(
6a488035
TO
1406 'name' => 'contributionPage',
1407 ),
1408 'add' => '4.1',
1409 'title' => 'Default online membership renewal page',
1410 'is_domain' => 1,
1411 'is_contact' => 0,
b25fe59a 1412 'description' => 'If you select a default online contribution page for self-service membership renewals, a \"renew\" link pointing to that page will be displayed on the Contact Dashboard for memberships which were entered offline. You will need to ensure that the membership block for the selected online contribution page includes any currently available memberships.',
6a488035
TO
1413 'help_text' => '',
1414 ),
53ca8fd7 1415 'is_enabled' => array(
6a488035
TO
1416 'group_name' => 'Multi Site Preferences',
1417 'group' => 'multisite',
1418 'name' => 'is_enabled',
89bf81b4 1419 'title' => 'Multisite Is enabled',
6a488035
TO
1420 'type' => 'Integer',
1421 'default' => '',
1422 'add' => '4.1',
1423 'is_domain' => 1,
1424 'is_contact' => 0,
1425 'description' => 'Multisite is enabled',
1426 'help_text' => '',
1427 ),
53ca8fd7 1428 'domain_group_id' => array(
6a488035
TO
1429 'group_name' => 'Multi Site Preferences',
1430 'group' => 'multisite',
1431 'name' => 'domain_group_id',
89bf81b4 1432 'title' => 'Multisite Domain Group',
6a488035
TO
1433 'type' => 'Integer',
1434 'default' => '',
1435 'add' => '4.1',
1436 'is_domain' => 1,
1437 'is_contact' => 0,
1438 'description' => '',
1439 'help_text' => '',
1440 ),
53ca8fd7 1441 'event_price_set_domain_id' => array(
6a488035
TO
1442 'group_name' => 'Multi Site Preferences',
1443 'group' => 'multisite',
1444 'name' => 'event_price_set_domain_id',
89bf81b4 1445 'title' => 'Domain Event Price Set',
6a488035
TO
1446 'type' => 'Integer',
1447 'default' => '',
1448 'add' => '4.1',
1449 'is_domain' => 1,
1450 'is_contact' => 0,
1451 'description' => '',
1452 'help_text' => '',
1453 ),
53ca8fd7 1454 'uniq_email_per_site' => array(
6a488035
TO
1455 'group_name' => 'Multi Site Preferences',
1456 'group' => 'multisite',
1457 'name' => 'uniq_email_per_site',
1458 'type' => 'Integer',
89bf81b4 1459 'title' => 'Unique Email per Domain?',
6a488035
TO
1460 'default' => '',
1461 'add' => '4.1',
1462 'is_domain' => 1,
1463 'is_contact' => 0,
1464 'description' => '',
1465 'help_text' => '',
1466 ),
53ca8fd7 1467 'search_autocomplete_count' => array(
6a488035
TO
1468 'group_name' => 'Search Preferences',
1469 'group' => 'Search Preferences',
1470 'name' => 'search_autocomplete_count',
1471 'prefetch' => 0,
1472 'type' => 'Integer',
1473 'quick_form_type' => 'Element',
1474 'html_type' => 'text',
53ca8fd7 1475 'html_attributes' => array(
6a488035
TO
1476 'size' => 2,
1477 'maxlength' => 2,
1478 ),
1479 'default' => 10,
1480 'add' => '4.3',
1481 'title' => 'Autocomplete Results',
1482 'is_domain' => 1,
1483 'is_contact' => 0,
1484 'description' => 'The maximum number of contacts to show at a time when typing in an autocomplete field.',
1485 'help_text' => '',
1486 ),
89bf81b4 1487 'enable_innodb_fts' => array(
1488 'group_name' => 'Search Preferences',
1489 'group' => 'Search Preferences',
1490 'name' => 'enable_innodb_fts',
1491 'prefetch' => 0,
1492 'type' => 'Boolean',
1493 'quick_form_type' => 'YesNo',
1494 'default' => 0,
1495 'add' => '4.4',
1496 'title' => 'InnoDB Full Text Search',
1497 'is_domain' => 1,
1498 'is_contact' => 0,
1499 'description' => 'Enable InnoDB full-text search optimizations. (Requires MySQL 5.6+)',
1500 'help_text' => '',
1501 'on_change' => array(
1502 '0' => array(
1503 '0' => 'CRM_Core_InnoDBIndexer',
1504 '1' => 'onToggleFts',
1505 ),
1506 ),
1507 ),
1508 'fts_query_mode' => array(
1509 'group_name' => 'Search Preferences',
1510 'group' => 'Search Preferences',
1511 'name' => 'fts_query_mode',
1512 'prefetch' => 0,
1513 'type' => 'String',
1514 'quick_form_type' => 'Element',
1515 'html_type' => 'Text',
1516 'html_attributes' => array(
1517 'size' => 64,
1518 'maxlength' => 64,
1519 ),
1520 'default' => 'simple',
1521 'add' => '4.5',
1522 'title' => 'How to handle full-tet queries',
1523 'is_domain' => 1,
1524 'is_contact' => 0,
1525 'description' => '',
1526 'help_text' => '',
1527 ),
53ca8fd7 1528 'userFrameworkResourceURL' => array(
b25fe59a
E
1529 'group' => 'url',
1530 'group_name' => 'URL Preferences',
6a488035 1531 'name' => 'userFrameworkResourceURL',
89bf81b4 1532 'title' => 'Script and CSS Resources URL',
6a488035
TO
1533 'type' => 'String',
1534 'default' => '',
1535 'add' => '4.1',
1536 'prefetch' => 1,
1537 'is_domain' => 1,
1538 'is_contact' => 0,
1539 'description' => 'CiviCRM Resource URL',
1540 'help_text' => '',
1541 'validate_callback' => 'CRM_Utils_Rule::url',
1542 ),
53ca8fd7 1543 'imageUploadURL' => array(
b25fe59a
E
1544 'group' => 'url',
1545 'group_name' => 'URL Preferences',
89bf81b4 1546 'title' => 'Image URL Prefix',
6a488035
TO
1547 'name' => 'imageUploadURL',
1548 'type' => 'String',
1549 'default' => '',
1550 'add' => '4.1',
1551 'prefetch' => 1,
1552 'is_domain' => 1,
1553 'is_contact' => 0,
1554 'description' => 'Image Upload URL',
1555 'help_text' => '',
1556 'validate_callback' => 'CRM_Utils_Rule::url',
1557 ),
53ca8fd7 1558 'customCSSURL' => array(
b25fe59a
E
1559 'group' => 'url',
1560 'group_name' => 'URL Preferences',
6a488035 1561 'name' => 'customCSSURL',
89bf81b4 1562 'title' => 'Custom CSS',
6a488035
TO
1563 'type' => 'String',
1564 'default' => '',
1565 'add' => '4.1',
1566 'prefetch' => 1,
1567 'is_domain' => 1,
1568 'is_contact' => 0,
1569 'description' => 'Custom CiviCRM CSS URL',
1570 'help_text' => '',
1571 'validate_callback' => 'CRM_Utils_Rule::url',
1572 ),
1573 ),
1574);
1575
fb32de45 1576 return $expectedResult;
6a488035
TO
1577}
1578
1579
1580/*
1581* This example has been generated from the API test suite. The test that created it is called
1582*
1583* testGetFields and can be found in
69d79249 1584* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
6a488035
TO
1585*
1586* You can see the outcome of the API tests at
69d79249 1587* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
1588*
1589* To Learn about the API read
69d79249 1590* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 1591*
69d79249
E
1592* Browse the api on your own site with the api explorer
1593* http://MYSITE.ORG/path/to/civicrm/api/explorer
6a488035
TO
1594*
1595* Read more about testing here
1596* http://wiki.civicrm.org/confluence/display/CRM/Testing
1597*
1598* API Standards documentation:
1599* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b25fe59a 1600*/