Merge pull request #6366 from jitendrapurohit/CRM-13644master
[civicrm-core.git] / api / v3 / examples / Setting / GetFields.php
CommitLineData
6a488035 1<?php
50fb255d 2/**
a828d7b8 3 * Test Generated example demonstrating the Setting.getfields API.
50fb255d 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{
a828d7b8 14 $result = civicrm_api3('Setting', 'getfields', $params);
50fb255d 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',
50fb255d 642 'html_attributes' => array(
643 'size' => 64,
644 'maxlength' => 256,
645 ),
5c49fee0 646 'html_type' => 'Text',
50fb255d 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',
50fb255d 663 'html_attributes' => array(
664 'size' => 64,
665 'maxlength' => 64,
666 ),
5c49fee0 667 'html_type' => 'Text',
50fb255d 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',
50fb255d 684 'html_attributes' => array(
685 'size' => 64,
686 'maxlength' => 64,
687 ),
5c49fee0 688 'html_type' => 'Text',
50fb255d 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',
50fb255d 705 'html_attributes' => array(
706 'size' => 3,
707 'maxlength' => 5,
708 ),
5c49fee0 709 'html_type' => 'Text',
50fb255d 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',
50fb255d 725 'html_attributes' => array(
726 'size' => 2,
727 'maxlength' => 8,
728 ),
5c49fee0 729 'html_type' => 'Text',
50fb255d 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',
50fb255d 745 'html_attributes' => array(
746 'size' => 64,
747 'maxlength' => 128,
748 ),
5c49fee0 749 'html_type' => 'Text',
50fb255d 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',
50fb255d 765 'html_attributes' => array(
766 'size' => 64,
767 'maxlength' => 128,
768 ),
5c49fee0 769 'html_type' => 'Text',
50fb255d 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',
50fb255d 786 'html_attributes' => array(
787 'size' => 16,
788 'maxlength' => 16,
789 ),
5c49fee0 790 'html_type' => 'Text',
50fb255d 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(
5c49fee0
CW
871 '0' => 'CRM_Case_Info::onToggleComponents',
872 '1' => 'CRM_Core_Component::flushEnabledComponents',
873 '2' => 'call://resources/resetCacheCode',
50fb255d 874 ),
875 ),
b25fe59a 876 'disable_core_css' => array(
50fb255d 877 'group_name' => 'CiviCRM Preferences',
878 'group' => 'core',
879 'name' => 'disable_core_css',
880 'type' => 'Boolean',
881 'quick_form_type' => 'YesNo',
882 'default' => 0,
883 'add' => '4.4',
884 'title' => 'Disable CiviCRM css',
885 'is_domain' => 1,
886 'is_contact' => 0,
887 'description' => 'Prevent the stylesheet \"civicrm.css\" from being loaded.',
888 'help_text' => '',
889 ),
466913fc 890 'empoweredBy' => array(
50fb255d 891 'group_name' => 'CiviCRM Preferences',
892 'group' => 'core',
893 'name' => 'empoweredBy',
894 'prefetch' => 1,
895 'type' => 'Boolean',
896 'quick_form_type' => 'YesNo',
897 'default' => 1,
898 'add' => '4.5',
899 'title' => 'Display \"empowered by CiviCRM\"',
900 'is_domain' => 1,
901 'is_contact' => 0,
902 'description' => 'When enabled, \"empowered by CiviCRM\" is displayed at the bottom of public forms.',
903 'help_text' => '',
904 ),
0b2bdd13 905 'userFrameworkLogging' => array(
50fb255d 906 'group_name' => 'Developer Preferences',
907 'group' => 'developer',
0b2bdd13 908 'name' => 'userFrameworkLogging',
50fb255d 909 'type' => 'Boolean',
910 'quick_form_type' => 'YesNo',
911 'default' => 0,
912 'add' => '4.3',
0b2bdd13 913 'title' => 'Enable Drupal Watchdog Logging',
50fb255d 914 'is_domain' => 1,
915 'is_contact' => 0,
0b2bdd13 916 'description' => 'Set this value to Yes if you want CiviCRM error/debugging messages to appear in the Drupal error logs',
50fb255d 917 'prefetch' => 1,
0b2bdd13 918 'help_text' => 'Set this value to Yes if you want CiviCRM error/debugging messages the appear in your CMS\' error log. In the case of Drupal, this will cause all CiviCRM error messages to appear in the watchdog (assuming you have Drupal\'s watchdog enabled)',
50fb255d 919 ),
0b2bdd13 920 'debug_enabled' => array(
50fb255d 921 'group_name' => 'Developer Preferences',
922 'group' => 'developer',
0b2bdd13
J
923 'name' => 'debug_enabled',
924 'config_key' => 'debug',
50fb255d 925 'type' => 'Boolean',
926 'quick_form_type' => 'YesNo',
927 'default' => 0,
928 'add' => '4.3',
0b2bdd13 929 'title' => 'Enable Debugging',
50fb255d 930 'is_domain' => 1,
931 'is_contact' => 0,
0b2bdd13 932 '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',
50fb255d 933 'prefetch' => 1,
0b2bdd13 934 'help_text' => 'Do not turn this on on production sites',
50fb255d 935 ),
53ca8fd7 936 'backtrace' => array(
50fb255d 937 'group_name' => 'Developer Preferences',
938 'group' => 'developer',
939 'name' => 'backtrace',
940 'type' => 'Boolean',
941 'quick_form_type' => 'YesNo',
942 'default' => 0,
943 'add' => '4.3',
944 'title' => 'Display Backtrace',
945 'is_domain' => 1,
946 'is_contact' => 0,
947 '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',
948 'prefetch' => 1,
949 ),
53ca8fd7 950 'fatalErrorHandler' => array(
50fb255d 951 'group_name' => 'Developer Preferences',
952 'group' => 'developer',
953 'name' => 'fatalErrorHandler',
954 'type' => 'String',
955 'quick_form_type' => 'Element',
956 'html_type' => 'text',
957 'default' => '',
958 'add' => '4.3',
959 'title' => 'Fatal Error Handler',
960 'is_domain' => 1,
961 'is_contact' => 0,
962 '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.',
963 'prefetch' => 1,
964 ),
53ca8fd7 965 'uploadDir' => array(
50fb255d 966 'group_name' => 'Directory Preferences',
967 'group' => 'directory',
968 'name' => 'uploadDir',
969 'type' => 'Url',
970 'html_type' => 'Text',
971 'default' => '',
972 'add' => '4.1',
973 'prefetch' => 1,
974 'title' => 'Upload Directory',
975 'is_domain' => 1,
976 'is_contact' => 0,
977 'description' => '',
978 'help_text' => '',
979 ),
53ca8fd7 980 'imageUploadDir' => array(
50fb255d 981 'group_name' => 'Directory Preferences',
982 'group' => 'directory',
983 'name' => 'imageUploadDir',
984 'type' => 'Url',
985 'html_type' => 'Text',
986 'default' => '',
987 'add' => '4.1',
988 'prefetch' => 1,
989 'title' => 'Image Directory',
990 'is_domain' => 1,
991 'is_contact' => 0,
992 'description' => '',
993 'help_text' => '',
994 ),
53ca8fd7 995 'customFileUploadDir' => array(
50fb255d 996 'group_name' => 'Directory Preferences',
997 'group' => 'directory',
998 'name' => 'customFileUploadDir',
999 'type' => 'Url',
1000 'html_type' => 'Text',
1001 'default' => '',
1002 'add' => '4.1',
1003 'prefetch' => 1,
1004 'title' => 'Custom Files Upload Directory',
1005 'is_domain' => 1,
1006 'is_contact' => 0,
1007 'description' => '',
1008 'help_text' => '',
1009 ),
53ca8fd7 1010 'customTemplateDir' => array(
50fb255d 1011 'group_name' => 'Directory Preferences',
1012 'group' => 'directory',
1013 'name' => 'customTemplateDir',
1014 'type' => 'Url',
1015 'html_type' => 'Text',
1016 'default' => '',
1017 'add' => '4.1',
1018 'prefetch' => 1,
1019 'title' => 'Custom Template Directory',
1020 'is_domain' => 1,
1021 'is_contact' => 0,
1022 'description' => '',
1023 'help_text' => '',
1024 ),
53ca8fd7 1025 'customPHPPathDir' => array(
50fb255d 1026 'group_name' => 'Directory Preferences',
1027 'group' => 'directory',
1028 'name' => 'customPHPPathDir',
1029 'type' => 'Url',
1030 'html_type' => 'Text',
1031 'default' => '',
1032 'add' => '4.1',
1033 'prefetch' => 1,
1034 'title' => 'Custom PHP Path',
1035 'is_domain' => 1,
1036 'is_contact' => 0,
1037 'description' => '',
1038 'help_text' => '',
1039 ),
53ca8fd7 1040 'extensionsDir' => array(
50fb255d 1041 'group_name' => 'Directory Preferences',
1042 'group' => 'directory',
1043 'name' => 'extensionsDir',
1044 'type' => 'Url',
1045 'html_type' => 'Text',
1046 'default' => '',
1047 'add' => '4.1',
1048 'prefetch' => 1,
1049 'title' => 'Extensions Directory',
1050 'is_domain' => 1,
1051 'is_contact' => 0,
1052 'description' => '',
1053 'help_text' => '',
1054 ),
53ca8fd7 1055 'event_enable_cart' => array(
50fb255d 1056 'name' => 'enable_cart',
1057 'group_name' => 'Event Preferences',
1058 'group' => 'event',
1059 'type' => 'String',
1060 'quick_form_type' => 'Element',
1061 'default' => 0,
1062 'add' => '4.1',
1063 'title' => 'Enable Event Cart',
1064 'is_domain' => 1,
1065 'is_contact' => 1,
1066 'description' => 'WRITE ME',
1067 'help_text' => 'WRITE ME',
1068 ),
53ca8fd7 1069 'monetaryThousandSeparator' => array(
50fb255d 1070 'group_name' => 'Localization Preferences',
1071 'group' => 'localization',
1072 'name' => 'monetaryThousandSeparator',
1073 'prefetch' => 1,
1074 'config_only' => 1,
1075 'type' => 'String',
1076 'quick_form_type' => 'Element',
1077 'html_type' => 'text',
1078 'html_attributes' => array(
1079 'size' => 2,
1080 ),
1081 'default' => ',',
1082 'add' => '4.3',
1083 'title' => 'Thousands Separator',
1084 'is_domain' => 1,
1085 'is_contact' => 0,
1086 'description' => '',
1087 'help_text' => '',
1088 ),
53ca8fd7 1089 'monetaryDecimalPoint' => array(
50fb255d 1090 'group_name' => 'Localization Preferences',
1091 'group' => 'localization',
1092 'name' => 'monetaryDecimalPoint',
1093 'prefetch' => 1,
1094 'config_only' => 1,
1095 'type' => 'String',
1096 'quick_form_type' => 'Element',
1097 'html_type' => 'text',
1098 'html_attributes' => array(
1099 'size' => 2,
1100 ),
1101 'default' => '.',
1102 'add' => '4.3',
1103 'title' => 'Decimal Delimiter',
1104 'is_domain' => 1,
1105 'is_contact' => 0,
1106 'description' => '',
1107 'help_text' => '',
1108 ),
53ca8fd7 1109 'moneyformat' => array(
50fb255d 1110 'group_name' => 'Localization Preferences',
1111 'group' => 'localization',
1112 'name' => 'moneyformat',
1113 'prefetch' => 1,
1114 'config_only' => 1,
1115 'type' => 'String',
1116 'quick_form_type' => 'Element',
1117 'html_type' => 'text',
1118 'default' => '%c %a',
1119 'add' => '4.3',
1120 'title' => 'Monetary Amount Display',
1121 'is_domain' => 1,
1122 'is_contact' => 0,
1123 'description' => '',
1124 'help_text' => '',
1125 ),
53ca8fd7 1126 'moneyvalueformat' => array(
50fb255d 1127 'group_name' => 'Localization Preferences',
1128 'group' => 'localization',
1129 'name' => 'moneyvalueformat',
1130 'prefetch' => 1,
1131 'config_only' => 1,
1132 'type' => 'String',
1133 'quick_form_type' => 'Element',
1134 'html_type' => 'text',
1135 'default' => '%!i',
1136 'add' => '4.3',
1137 'title' => 'Monetary Amount Display',
1138 'is_domain' => 1,
1139 'is_contact' => 0,
1140 'description' => '',
1141 'help_text' => '',
1142 ),
53ca8fd7 1143 'defaultCurrency' => array(
50fb255d 1144 'group_name' => 'Localization Preferences',
1145 'group' => 'localization',
1146 'name' => 'defaultCurrency',
1147 'prefetch' => 1,
1148 'config_only' => 1,
1149 'type' => 'String',
1150 'quick_form_type' => 'Element',
1151 'html_type' => 'text',
1152 'html_attributes' => array(
1153 'size' => 2,
1154 ),
1155 'default' => 'USD',
1156 'add' => '4.3',
1157 'title' => 'Default Currency',
1158 'is_domain' => 1,
1159 'is_contact' => 0,
1160 'description' => 'Default currency assigned to contributions and other monetary transactions.',
1161 'help_text' => '',
1162 ),
b25fe59a 1163 'defaultContactCountry' => array(
50fb255d 1164 'group_name' => 'Localization Preferences',
1165 'group' => 'localization',
1166 'name' => 'defaultContactCountry',
1167 'prefetch' => 1,
1168 'config_only' => 1,
1169 'type' => 'String',
1170 'quick_form_type' => 'Element',
1171 'html_type' => 'text',
1172 'html_attributes' => array(
1173 'size' => 4,
1174 ),
1175 'default' => '1228',
1176 'add' => '4.4',
1177 'title' => 'Default Country',
1178 'is_domain' => 1,
1179 'is_contact' => 0,
1180 'description' => 'This value is selected by default when adding a new contact address.',
1181 'help_text' => '',
1182 ),
53ca8fd7 1183 'countryLimit' => array(
50fb255d 1184 'group_name' => 'Localization Preferences',
1185 'group' => 'localization',
1186 'name' => 'countryLimit',
1187 'prefetch' => 1,
1188 'config_only' => 1,
1189 'type' => 'Array',
1190 'quick_form_type' => 'Element',
1191 'html_type' => 'advmultiselect',
1192 'html_attributes' => array(
1193 'size' => 5,
1194 'style' => 'width:150px',
1195 'class' => 'advmultiselect',
1196 ),
1197 'default' => 'null',
1198 'add' => '4.3',
1199 'title' => 'Available Countries',
1200 'is_domain' => 1,
1201 'is_contact' => 0,
1202 'description' => '',
1203 'help_text' => '',
1204 ),
53ca8fd7 1205 'provinceLimit' => array(
50fb255d 1206 'group_name' => 'Localization Preferences',
1207 'group' => 'localization',
1208 'name' => 'provinceLimit',
1209 'prefetch' => 1,
1210 'config_only' => 1,
1211 'type' => 'Array',
1212 'quick_form_type' => 'Element',
1213 'html_type' => 'advmultiselect',
1214 'html_attributes' => array(
1215 'size' => 5,
1216 'style' => 'width:150px',
1217 'class' => 'advmultiselect',
1218 ),
1219 'default' => 'null',
1220 'add' => '4.3',
1221 'title' => 'Available States and Provinces',
1222 'is_domain' => 1,
1223 'is_contact' => 0,
1224 'description' => '',
1225 'help_text' => '',
1226 ),
53ca8fd7 1227 'inheritLocale' => array(
50fb255d 1228 'group_name' => 'Localization Preferences',
1229 'group' => 'localization',
1230 'name' => 'inheritLocale',
1231 'prefetch' => 1,
1232 'config_only' => 1,
1233 'type' => 'Boolean',
1234 'quick_form_type' => 'YesNo',
1235 'default' => 0,
1236 'add' => '4.3',
1237 'title' => 'Inherit CMS Language',
1238 'is_domain' => 1,
1239 'is_contact' => 0,
1240 'description' => '',
1241 'help_text' => '',
1242 ),
53ca8fd7 1243 'dateformatDatetime' => array(
50fb255d 1244 'group_name' => 'Localization Preferences',
1245 'group' => 'localization',
1246 'name' => 'dateformatDatetime',
1247 'prefetch' => 1,
1248 'config_only' => 1,
1249 'type' => 'String',
1250 'default' => '%B %E%f, %Y %l:%M %P',
1251 'add' => '4.3',
1252 'title' => 'Complete Date and Time',
1253 'is_domain' => 1,
1254 'is_contact' => 0,
1255 'description' => '',
1256 'help_text' => '',
1257 ),
53ca8fd7 1258 'dateformatFull' => array(
50fb255d 1259 'group_name' => 'Localization Preferences',
1260 'group' => 'localization',
1261 'name' => 'dateformatFull',
1262 'prefetch' => 1,
1263 'config_only' => 1,
1264 'type' => 'String',
1265 'default' => '%B %E%f, %Y',
1266 'add' => '4.3',
1267 'title' => 'Complete Date',
1268 'is_domain' => 1,
1269 'is_contact' => 0,
1270 'description' => '',
1271 'help_text' => '',
1272 ),
53ca8fd7 1273 'dateformatPartial' => array(
50fb255d 1274 'group_name' => 'Localization Preferences',
1275 'group' => 'localization',
1276 'name' => 'dateformatPartial',
1277 'prefetch' => 1,
1278 'config_only' => 1,
1279 'type' => 'String',
1280 'default' => '%B %Y',
1281 'add' => '4.3',
1282 'title' => 'Month and Year',
1283 'is_domain' => 1,
1284 'is_contact' => 0,
1285 'description' => '',
1286 'help_text' => '',
1287 ),
53ca8fd7 1288 'lcMessages' => array(
50fb255d 1289 'group_name' => 'Localization Preferences',
1290 'group' => 'localization',
1291 'name' => 'lcMessages',
1292 'prefetch' => 1,
1293 'config_only' => 1,
1294 'type' => 'String',
1295 'default' => 'en_US',
1296 'add' => '4.3',
1297 'title' => 'Default Language',
1298 'is_domain' => 1,
1299 'is_contact' => 0,
1300 'description' => '',
1301 'help_text' => '',
1302 ),
53ca8fd7 1303 'profile_double_optin' => array(
50fb255d 1304 'group_name' => 'Mailing Preferences',
1305 'group' => 'mailing',
1306 'name' => 'profile_double_optin',
1307 'type' => 'Integer',
1308 'html_type' => 'checkbox',
1309 'default' => 0,
1310 'add' => '4.1',
1311 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1312 'is_domain' => 1,
1313 'is_contact' => 0,
1314 '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.',
1315 'help_text' => '',
1316 ),
53ca8fd7 1317 'track_civimail_replies' => array(
50fb255d 1318 'group_name' => 'Mailing Preferences',
1319 'group' => 'mailing',
1320 'name' => 'track_civimail_replies',
1321 'type' => 'Integer',
1322 'html_type' => 'checkbox',
1323 'default' => 0,
1324 'add' => '4.1',
5c49fee0 1325 'title' => 'Track replies using VERP in Reply-To header',
50fb255d 1326 'is_domain' => 1,
1327 'is_contact' => 0,
5c49fee0 1328 'description' => 'If checked, mailings will default to tracking replies using VERP-ed Reply-To. ',
50fb255d 1329 'help_text' => '',
1330 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting',
1331 ),
53ca8fd7 1332 'civimail_workflow' => array(
50fb255d 1333 'group_name' => 'Mailing Preferences',
1334 'group' => 'mailing',
1335 'name' => 'civimail_workflow',
1336 'type' => 'Integer',
1337 'html_type' => 'checkbox',
1338 'default' => 0,
1339 'add' => '4.1',
1340 'title' => 'Use CiviMail Workflow',
1341 'is_domain' => 1,
1342 'is_contact' => 0,
1343 '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.',
1344 'help_text' => '',
1345 ),
53ca8fd7 1346 'civimail_server_wide_lock' => array(
50fb255d 1347 'group_name' => 'Mailing Preferences',
1348 'group' => 'mailing',
1349 'name' => 'civimail_server_wide_lock',
1350 'type' => 'Integer',
1351 'html_type' => 'checkbox',
1352 'default' => 0,
1353 'add' => '4.1',
1354 'title' => 'Lock Mails Server-Wide for Mail Sending',
1355 'is_domain' => 1,
1356 'is_contact' => 0,
1357 'description' => '',
1358 'help_text' => '',
1359 ),
53ca8fd7 1360 'mailing_backend' => array(
50fb255d 1361 'group_name' => 'Mailing Preferences',
1362 'group' => 'mailing',
1363 'name' => 'mailing_backend',
1364 'type' => 'Array',
1365 'html_type' => 'checkbox',
1366 'default' => 0,
1367 'add' => '4.1',
1368 'title' => 'Mailing Backend',
1369 'is_domain' => 1,
1370 'is_contact' => 0,
1371 'description' => '',
1372 'help_text' => '',
1373 ),
53ca8fd7 1374 'profile_add_to_group_double_optin' => array(
50fb255d 1375 'group_name' => 'Mailing Preferences',
1376 'group' => 'mailing',
1377 'name' => 'profile_add_to_group_double_optin',
1378 'type' => 'Integer',
1379 'html_type' => 'checkbox',
1380 'default' => 0,
1381 'add' => '4.1',
1382 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1383 'is_domain' => 1,
1384 'is_contact' => 0,
1385 '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.',
1386 'help_text' => '',
1387 ),
b25fe59a 1388 'disable_mandatory_tokens_check' => array(
50fb255d 1389 'group_name' => 'Mailing Preferences',
1390 'group' => 'mailing',
1391 'name' => 'disable_mandatory_tokens_check',
1392 'type' => 'Integer',
1393 'html_type' => 'checkbox',
1394 'default' => 0,
1395 'add' => '4.4',
1396 'title' => 'Disable check for mandatory tokens',
1397 'is_domain' => 1,
1398 'is_contact' => 0,
1399 '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.',
1400 'help_text' => '',
1401 ),
89bf81b4 1402 'dedupe_email_default' => array(
50fb255d 1403 'group_name' => 'Mailing Preferences',
1404 'group' => 'mailing',
1405 'name' => 'dedupe_email_default',
1406 'type' => 'Integer',
1407 'html_type' => 'checkbox',
1408 'default' => 1,
1409 'add' => '4.5',
1410 'title' => 'CiviMail dedupes e-mail addresses by default',
1411 'is_domain' => 1,
1412 'is_contact' => 0,
1413 'description' => 'Set the \"dedupe e-mail\" option when sending a new mailing to \"true\" by default.',
1414 'help_text' => '',
1415 ),
89bf81b4 1416 'hash_mailing_url' => array(
50fb255d 1417 'group_name' => 'Mailing Preferences',
1418 'group' => 'mailing',
1419 'name' => 'hash_mailing_url',
1420 'type' => 'Integer',
1421 'html_type' => 'checkbox',
1422 'default' => 0,
1423 'add' => '4.5',
1424 'title' => 'Hashed Mailing URL\'s',
1425 'is_domain' => 1,
1426 'is_contact' => 0,
1427 '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',
1428 'help_text' => '',
1429 ),
53ca8fd7 1430 'default_renewal_contribution_page' => array(
50fb255d 1431 'group_name' => 'Member Preferences',
1432 'group' => 'member',
1433 'name' => 'default_renewal_contribution_page',
1434 'type' => 'Integer',
1435 'html_type' => 'Select',
1436 'default' => '',
1437 'pseudoconstant' => array(
1438 'name' => 'contributionPage',
1439 ),
1440 'add' => '4.1',
1441 'title' => 'Default online membership renewal page',
1442 'is_domain' => 1,
1443 'is_contact' => 0,
1444 '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.',
1445 'help_text' => '',
1446 ),
53ca8fd7 1447 'is_enabled' => array(
50fb255d 1448 'group_name' => 'Multi Site Preferences',
1449 'group' => 'multisite',
1450 'name' => 'is_enabled',
1451 'title' => 'Multisite Is enabled',
1452 'type' => 'Integer',
1453 'default' => '',
1454 'add' => '4.1',
1455 'is_domain' => 1,
1456 'is_contact' => 0,
1457 'description' => 'Multisite is enabled',
1458 'help_text' => '',
1459 ),
53ca8fd7 1460 'domain_group_id' => array(
50fb255d 1461 'group_name' => 'Multi Site Preferences',
1462 'group' => 'multisite',
1463 'name' => 'domain_group_id',
1464 'title' => 'Multisite Domain Group',
1465 'type' => 'Integer',
1466 'default' => '',
1467 'add' => '4.1',
1468 'is_domain' => 1,
1469 'is_contact' => 0,
1470 'description' => '',
1471 'help_text' => '',
1472 ),
53ca8fd7 1473 'event_price_set_domain_id' => array(
50fb255d 1474 'group_name' => 'Multi Site Preferences',
1475 'group' => 'multisite',
1476 'name' => 'event_price_set_domain_id',
1477 'title' => 'Domain Event Price Set',
1478 'type' => 'Integer',
1479 'default' => '',
1480 'add' => '4.1',
1481 'is_domain' => 1,
1482 'is_contact' => 0,
1483 'description' => '',
1484 'help_text' => '',
1485 ),
53ca8fd7 1486 'uniq_email_per_site' => array(
50fb255d 1487 'group_name' => 'Multi Site Preferences',
1488 'group' => 'multisite',
1489 'name' => 'uniq_email_per_site',
1490 'type' => 'Integer',
1491 'title' => 'Unique Email per Domain?',
1492 'default' => '',
1493 'add' => '4.1',
1494 'is_domain' => 1,
1495 'is_contact' => 0,
1496 'description' => '',
1497 'help_text' => '',
1498 ),
53ca8fd7 1499 'search_autocomplete_count' => array(
50fb255d 1500 'group_name' => 'Search Preferences',
1501 'group' => 'Search Preferences',
1502 'name' => 'search_autocomplete_count',
1503 'prefetch' => 0,
1504 'type' => 'Integer',
1505 'quick_form_type' => 'Element',
1506 'html_type' => 'text',
1507 'html_attributes' => array(
1508 'size' => 2,
1509 'maxlength' => 2,
1510 ),
1511 'default' => 10,
1512 'add' => '4.3',
1513 'title' => 'Autocomplete Results',
1514 'is_domain' => 1,
1515 'is_contact' => 0,
1516 'description' => 'The maximum number of contacts to show at a time when typing in an autocomplete field.',
1517 'help_text' => '',
1518 ),
89bf81b4 1519 'enable_innodb_fts' => array(
50fb255d 1520 'group_name' => 'Search Preferences',
1521 'group' => 'Search Preferences',
1522 'name' => 'enable_innodb_fts',
1523 'prefetch' => 0,
1524 'type' => 'Boolean',
1525 'quick_form_type' => 'YesNo',
1526 'default' => 0,
1527 'add' => '4.4',
1528 'title' => 'InnoDB Full Text Search',
1529 'is_domain' => 1,
1530 'is_contact' => 0,
1531 'description' => 'Enable InnoDB full-text search optimizations. (Requires MySQL 5.6+)',
1532 'help_text' => '',
1533 'on_change' => array(
1534 '0' => array(
1535 '0' => 'CRM_Core_InnoDBIndexer',
1536 '1' => 'onToggleFts',
1537 ),
1538 ),
1539 ),
89bf81b4 1540 'fts_query_mode' => array(
50fb255d 1541 'group_name' => 'Search Preferences',
1542 'group' => 'Search Preferences',
1543 'name' => 'fts_query_mode',
1544 'prefetch' => 0,
1545 'type' => 'String',
1546 'quick_form_type' => 'Element',
50fb255d 1547 'html_attributes' => array(
1548 'size' => 64,
1549 'maxlength' => 64,
1550 ),
5c49fee0 1551 'html_type' => 'Text',
50fb255d 1552 'default' => 'simple',
1553 'add' => '4.5',
1554 'title' => 'How to handle full-tet queries',
1555 'is_domain' => 1,
1556 'is_contact' => 0,
1557 'description' => '',
1558 'help_text' => '',
1559 ),
53ca8fd7 1560 'userFrameworkResourceURL' => array(
50fb255d 1561 'group' => 'url',
1562 'group_name' => 'URL Preferences',
1563 'name' => 'userFrameworkResourceURL',
1564 'title' => 'Script and CSS Resources URL',
1565 'type' => 'String',
1566 'default' => '',
1567 'add' => '4.1',
1568 'prefetch' => 1,
1569 'is_domain' => 1,
1570 'is_contact' => 0,
1571 'description' => 'CiviCRM Resource URL',
1572 'help_text' => '',
1573 'validate_callback' => 'CRM_Utils_Rule::url',
1574 ),
53ca8fd7 1575 'imageUploadURL' => array(
50fb255d 1576 'group' => 'url',
1577 'group_name' => 'URL Preferences',
1578 'title' => 'Image URL Prefix',
1579 'name' => 'imageUploadURL',
1580 'type' => 'String',
1581 'default' => '',
1582 'add' => '4.1',
1583 'prefetch' => 1,
1584 'is_domain' => 1,
1585 'is_contact' => 0,
1586 'description' => 'Image Upload URL',
1587 'help_text' => '',
1588 'validate_callback' => 'CRM_Utils_Rule::url',
1589 ),
53ca8fd7 1590 'customCSSURL' => array(
50fb255d 1591 'group' => 'url',
1592 'group_name' => 'URL Preferences',
1593 'name' => 'customCSSURL',
1594 'title' => 'Custom CSS',
1595 'type' => 'String',
1596 'default' => '',
1597 'add' => '4.1',
1598 'prefetch' => 1,
1599 'is_domain' => 1,
1600 'is_contact' => 0,
1601 'description' => 'Custom CiviCRM CSS URL',
1602 'help_text' => '',
1603 'validate_callback' => 'CRM_Utils_Rule::url',
1604 ),
6a488035 1605 ),
50fb255d 1606 );
6a488035 1607
fb32de45 1608 return $expectedResult;
6a488035
TO
1609}
1610
a828d7b8 1611/*
50fb255d 1612* This example has been generated from the API test suite.
a828d7b8
CW
1613* The test that created it is called "testGetFields"
1614* and can be found at:
69d79249 1615* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
6a488035
TO
1616*
1617* You can see the outcome of the API tests at
69d79249 1618* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
1619*
1620* To Learn about the API read
69d79249 1621* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 1622*
69d79249 1623* Browse the api on your own site with the api explorer
41d4d31f 1624* http://MYSITE.ORG/path/to/civicrm/api
6a488035
TO
1625*
1626* Read more about testing here
1627* http://wiki.civicrm.org/confluence/display/CRM/Testing
1628*
1629* API Standards documentation:
1630* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b25fe59a 1631*/