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