CRM-17663 - Configurable cache time per dashlet & auto-refresh
[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 ),
89bf81b4 530 'securityAlert' => array(
50fb255d 531 'group_name' => 'CiviCRM Preferences',
532 'group' => 'core',
533 'name' => 'securityAlert',
534 'type' => 'Boolean',
535 'quick_form_type' => 'YesNo',
536 'default' => 1,
537 'add' => '4.4',
538 'title' => 'Security Audits',
539 'is_domain' => 1,
540 'is_contact' => 0,
541 'description' => 'If enabled, CiviCRM will automatically run checks for significant mis-configurations such as ineffective file protections.',
542 'help_text' => '',
543 ),
53ca8fd7 544 'doNotAttachPDFReceipt' => array(
50fb255d 545 'group_name' => 'CiviCRM Preferences',
546 'group' => 'core',
547 'name' => 'doNotAttachPDFReceipt',
548 'prefetch' => 1,
549 'config_only' => 1,
550 'type' => 'Boolean',
551 'quick_form_type' => 'YesNo',
552 'default' => 1,
553 'add' => '4.3',
554 'title' => 'Attach PDF copy to receipts',
555 'is_domain' => 1,
556 'is_contact' => 0,
557 'description' => 'If enabled, CiviCRM sends PDF receipt as an attachment during event signup or online contribution.',
558 'help_text' => '',
559 ),
53ca8fd7 560 'wkhtmltopdfPath' => array(
50fb255d 561 'group_name' => 'CiviCRM Preferences',
562 'group' => 'core',
563 'name' => 'wkhtmltopdfPath',
564 'prefetch' => 1,
565 'config_only' => 1,
566 'type' => 'String',
567 'quick_form_type' => 'Element',
50fb255d 568 'html_attributes' => array(
569 'size' => 64,
570 'maxlength' => 256,
571 ),
5c49fee0 572 'html_type' => 'Text',
50fb255d 573 'default' => '',
574 'add' => '4.3',
575 'title' => 'Path to wkhtmltopdf executable',
576 'is_domain' => 1,
577 'is_contact' => 0,
578 'description' => '',
579 'help_text' => '',
580 ),
53ca8fd7 581 'recaptchaPublicKey' => array(
50fb255d 582 'group_name' => 'CiviCRM Preferences',
583 'group' => 'core',
584 'name' => 'recaptchaPublicKey',
585 'prefetch' => 1,
586 'config_only' => 1,
587 'type' => 'String',
588 'quick_form_type' => 'Element',
50fb255d 589 'html_attributes' => array(
590 'size' => 64,
591 'maxlength' => 64,
592 ),
5c49fee0 593 'html_type' => 'Text',
50fb255d 594 'default' => '',
595 'add' => '4.3',
cf7eb07b 596 'title' => 'Recaptcha Site Key',
50fb255d 597 'is_domain' => 1,
598 'is_contact' => 0,
599 'description' => '',
600 'help_text' => '',
601 ),
53ca8fd7 602 'recaptchaPrivateKey' => array(
50fb255d 603 'group_name' => 'CiviCRM Preferences',
604 'group' => 'core',
605 'name' => 'recaptchaPrivateKey',
606 'prefetch' => 1,
607 'config_only' => 1,
608 'type' => 'String',
609 'quick_form_type' => 'Element',
50fb255d 610 'html_attributes' => array(
611 'size' => 64,
612 'maxlength' => 64,
613 ),
5c49fee0 614 'html_type' => 'Text',
50fb255d 615 'default' => '',
616 'add' => '4.3',
cf7eb07b 617 'title' => 'Recaptcha Secret Key',
50fb255d 618 'is_domain' => 1,
619 'is_contact' => 0,
620 'description' => '',
621 'help_text' => '',
622 ),
53ca8fd7 623 'checksumTimeout' => array(
50fb255d 624 'group_name' => 'CiviCRM Preferences',
625 'group' => 'core',
626 'name' => 'checksumTimeout',
627 'prefetch' => 1,
628 'type' => 'Integer',
629 'quick_form_type' => 'Element',
50fb255d 630 'html_attributes' => array(
631 'size' => 2,
632 'maxlength' => 8,
633 ),
5c49fee0 634 'html_type' => 'Text',
50fb255d 635 'default' => 7,
636 'add' => '4.3',
637 'title' => 'Checksum Lifespan',
638 'is_domain' => 1,
639 'is_contact' => 0,
640 'description' => '',
641 'help_text' => '',
642 ),
4ed37178 643 'blogUrl' => array(
50fb255d 644 'group_name' => 'CiviCRM Preferences',
645 'group' => 'core',
646 'name' => 'blogUrl',
647 'prefetch' => 0,
648 'type' => 'String',
649 'quick_form_type' => 'Element',
50fb255d 650 'html_attributes' => array(
651 'size' => 64,
652 'maxlength' => 128,
653 ),
5c49fee0 654 'html_type' => 'Text',
50fb255d 655 'default' => '*default*',
656 'add' => '4.3',
657 'title' => 'Blog Feed URL',
658 'is_domain' => 1,
659 'is_contact' => 0,
660 'description' => 'Blog feed URL used by the blog dashlet',
661 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
662 ),
53ca8fd7 663 'communityMessagesUrl' => array(
50fb255d 664 'group_name' => 'CiviCRM Preferences',
665 'group' => 'core',
666 'name' => 'communityMessagesUrl',
667 'prefetch' => 0,
668 'type' => 'String',
669 'quick_form_type' => 'Element',
50fb255d 670 'html_attributes' => array(
671 'size' => 64,
672 'maxlength' => 128,
673 ),
5c49fee0 674 'html_type' => 'Text',
50fb255d 675 'default' => '*default*',
676 'add' => '4.3',
677 'title' => 'Community Messages URL',
678 'is_domain' => 1,
679 'is_contact' => 0,
680 'description' => 'Service providing CiviCRM community messages',
681 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
682 ),
53ca8fd7 683 'resCacheCode' => array(
50fb255d 684 'group_name' => 'CiviCRM Preferences',
685 'group' => 'core',
686 'name' => 'resCacheCode',
687 'prefetch' => 1,
688 'config_only' => 1,
689 'type' => 'String',
690 'quick_form_type' => 'Element',
50fb255d 691 'html_attributes' => array(
692 'size' => 16,
693 'maxlength' => 16,
694 ),
5c49fee0 695 'html_type' => 'Text',
50fb255d 696 'default' => '',
697 'add' => '4.3',
698 'title' => 'Resource Cache Code',
699 'is_domain' => 1,
700 'is_contact' => 0,
701 'description' => 'Code appended to resource URLs (JS/CSS) to coerce HTTP caching',
702 'help_text' => '',
703 ),
53ca8fd7 704 'verifySSL' => array(
50fb255d 705 'group_name' => 'CiviCRM Preferences',
706 'group' => 'core',
707 'name' => 'verifySSL',
708 'type' => 'Boolean',
709 'quick_form_type' => 'YesNo',
710 'default' => 1,
711 'add' => '4.3',
712 'title' => 'Verify SSL?',
713 'is_domain' => 1,
714 'is_contact' => 0,
715 'description' => 'If disabled, backend HTTPS services will allow unverified, insecure connections',
716 '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',
717 ),
53ca8fd7 718 'wpBasePage' => array(
50fb255d 719 'group_name' => 'CiviCRM Preferences',
720 'group' => 'core',
721 'name' => 'wpBasePage',
722 'type' => 'String',
723 'html_type' => 'text',
724 'quick_form_type' => 'Element',
725 'prefetch' => 1,
726 'default' => '',
727 'add' => '4.3',
728 'title' => 'WordPress Base Page',
729 'is_domain' => 1,
730 'is_contact' => 0,
731 'description' => 'If set, CiviCRM will use this setting as the base url.',
732 '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.',
733 ),
d5f1ee75 734 'secondDegRelPermissions' => array(
50fb255d 735 'group_name' => 'CiviCRM Preferences',
736 'group' => 'core',
737 'name' => 'secondDegRelPermissions',
738 'prefetch' => 1,
739 'type' => 'Boolean',
740 'quick_form_type' => 'YesNo',
741 'default' => 0,
742 'add' => '4.3',
743 'title' => 'Allow second-degree relationship permissions',
744 'is_domain' => 1,
745 'is_contact' => 0,
746 'description' => 'If enabled, contacts with the permission to edit a related contact will inherit that contact\'s permission to edit other related contacts',
747 'help_text' => '',
748 ),
fb32de45 749 'enable_components' => array(
50fb255d 750 'group_name' => 'CiviCRM Preferences',
751 'group' => 'core',
752 'name' => 'enable_components',
753 'type' => 'Array',
754 'quick_form_type' => 'Element',
755 'html_type' => 'advmultiselect',
756 'html_attributes' => array(
757 'size' => 5,
758 'style' => 'width:150px',
759 'class' => 'advmultiselect',
760 ),
761 'default' => array(
762 '0' => 'CiviEvent',
763 '1' => 'CiviContribute',
764 '2' => 'CiviMember',
765 '3' => 'CiviMail',
766 '4' => 'CiviReport',
767 '5' => 'CiviPledge',
768 ),
769 'add' => '4.4',
770 'title' => 'Enable Components',
771 'is_domain' => '1',
772 'is_contact' => 0,
773 'description' => '',
774 'help_text' => '',
775 'on_change' => array(
5c49fee0
CW
776 '0' => 'CRM_Case_Info::onToggleComponents',
777 '1' => 'CRM_Core_Component::flushEnabledComponents',
778 '2' => 'call://resources/resetCacheCode',
50fb255d 779 ),
780 ),
b25fe59a 781 'disable_core_css' => array(
50fb255d 782 'group_name' => 'CiviCRM Preferences',
783 'group' => 'core',
784 'name' => 'disable_core_css',
785 'type' => 'Boolean',
786 'quick_form_type' => 'YesNo',
787 'default' => 0,
788 'add' => '4.4',
789 'title' => 'Disable CiviCRM css',
790 'is_domain' => 1,
791 'is_contact' => 0,
792 'description' => 'Prevent the stylesheet \"civicrm.css\" from being loaded.',
793 'help_text' => '',
794 ),
466913fc 795 'empoweredBy' => array(
50fb255d 796 'group_name' => 'CiviCRM Preferences',
797 'group' => 'core',
798 'name' => 'empoweredBy',
799 'prefetch' => 1,
800 'type' => 'Boolean',
801 'quick_form_type' => 'YesNo',
802 'default' => 1,
803 'add' => '4.5',
804 'title' => 'Display \"empowered by CiviCRM\"',
805 'is_domain' => 1,
806 'is_contact' => 0,
807 'description' => 'When enabled, \"empowered by CiviCRM\" is displayed at the bottom of public forms.',
808 'help_text' => '',
809 ),
0b2bdd13 810 'userFrameworkLogging' => array(
50fb255d 811 'group_name' => 'Developer Preferences',
812 'group' => 'developer',
0b2bdd13 813 'name' => 'userFrameworkLogging',
50fb255d 814 'type' => 'Boolean',
815 'quick_form_type' => 'YesNo',
816 'default' => 0,
817 'add' => '4.3',
0b2bdd13 818 'title' => 'Enable Drupal Watchdog Logging',
50fb255d 819 'is_domain' => 1,
820 'is_contact' => 0,
0b2bdd13 821 'description' => 'Set this value to Yes if you want CiviCRM error/debugging messages to appear in the Drupal error logs',
50fb255d 822 'prefetch' => 1,
0b2bdd13 823 '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 824 ),
0b2bdd13 825 'debug_enabled' => array(
50fb255d 826 'group_name' => 'Developer Preferences',
827 'group' => 'developer',
0b2bdd13
J
828 'name' => 'debug_enabled',
829 'config_key' => 'debug',
50fb255d 830 'type' => 'Boolean',
831 'quick_form_type' => 'YesNo',
832 'default' => 0,
833 'add' => '4.3',
0b2bdd13 834 'title' => 'Enable Debugging',
50fb255d 835 'is_domain' => 1,
836 'is_contact' => 0,
0b2bdd13 837 '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 838 'prefetch' => 1,
0b2bdd13 839 'help_text' => 'Do not turn this on on production sites',
50fb255d 840 ),
53ca8fd7 841 'backtrace' => array(
50fb255d 842 'group_name' => 'Developer Preferences',
843 'group' => 'developer',
844 'name' => 'backtrace',
845 'type' => 'Boolean',
846 'quick_form_type' => 'YesNo',
847 'default' => 0,
848 'add' => '4.3',
849 'title' => 'Display Backtrace',
850 'is_domain' => 1,
851 'is_contact' => 0,
852 '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',
853 'prefetch' => 1,
854 ),
53ca8fd7 855 'fatalErrorHandler' => array(
50fb255d 856 'group_name' => 'Developer Preferences',
857 'group' => 'developer',
858 'name' => 'fatalErrorHandler',
859 'type' => 'String',
860 'quick_form_type' => 'Element',
861 'html_type' => 'text',
862 'default' => '',
863 'add' => '4.3',
864 'title' => 'Fatal Error Handler',
865 'is_domain' => 1,
866 'is_contact' => 0,
867 '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.',
868 'prefetch' => 1,
869 ),
53ca8fd7 870 'uploadDir' => array(
50fb255d 871 'group_name' => 'Directory Preferences',
872 'group' => 'directory',
873 'name' => 'uploadDir',
874 'type' => 'Url',
875 'html_type' => 'Text',
876 'default' => '',
877 'add' => '4.1',
878 'prefetch' => 1,
879 'title' => 'Upload Directory',
880 'is_domain' => 1,
881 'is_contact' => 0,
882 'description' => '',
883 'help_text' => '',
884 ),
53ca8fd7 885 'imageUploadDir' => array(
50fb255d 886 'group_name' => 'Directory Preferences',
887 'group' => 'directory',
888 'name' => 'imageUploadDir',
889 'type' => 'Url',
890 'html_type' => 'Text',
891 'default' => '',
892 'add' => '4.1',
893 'prefetch' => 1,
894 'title' => 'Image Directory',
895 'is_domain' => 1,
896 'is_contact' => 0,
897 'description' => '',
898 'help_text' => '',
899 ),
53ca8fd7 900 'customFileUploadDir' => array(
50fb255d 901 'group_name' => 'Directory Preferences',
902 'group' => 'directory',
903 'name' => 'customFileUploadDir',
904 'type' => 'Url',
905 'html_type' => 'Text',
906 'default' => '',
907 'add' => '4.1',
908 'prefetch' => 1,
909 'title' => 'Custom Files Upload Directory',
910 'is_domain' => 1,
911 'is_contact' => 0,
912 'description' => '',
913 'help_text' => '',
914 ),
53ca8fd7 915 'customTemplateDir' => array(
50fb255d 916 'group_name' => 'Directory Preferences',
917 'group' => 'directory',
918 'name' => 'customTemplateDir',
919 'type' => 'Url',
920 'html_type' => 'Text',
921 'default' => '',
922 'add' => '4.1',
923 'prefetch' => 1,
924 'title' => 'Custom Template Directory',
925 'is_domain' => 1,
926 'is_contact' => 0,
927 'description' => '',
928 'help_text' => '',
929 ),
53ca8fd7 930 'customPHPPathDir' => array(
50fb255d 931 'group_name' => 'Directory Preferences',
932 'group' => 'directory',
933 'name' => 'customPHPPathDir',
934 'type' => 'Url',
935 'html_type' => 'Text',
936 'default' => '',
937 'add' => '4.1',
938 'prefetch' => 1,
939 'title' => 'Custom PHP Path',
940 'is_domain' => 1,
941 'is_contact' => 0,
942 'description' => '',
943 'help_text' => '',
944 ),
53ca8fd7 945 'extensionsDir' => array(
50fb255d 946 'group_name' => 'Directory Preferences',
947 'group' => 'directory',
948 'name' => 'extensionsDir',
949 'type' => 'Url',
950 'html_type' => 'Text',
951 'default' => '',
952 'add' => '4.1',
953 'prefetch' => 1,
954 'title' => 'Extensions Directory',
955 'is_domain' => 1,
956 'is_contact' => 0,
957 'description' => '',
958 'help_text' => '',
959 ),
53ca8fd7 960 'event_enable_cart' => array(
50fb255d 961 'name' => 'enable_cart',
962 'group_name' => 'Event Preferences',
963 'group' => 'event',
964 'type' => 'String',
965 'quick_form_type' => 'Element',
966 'default' => 0,
967 'add' => '4.1',
968 'title' => 'Enable Event Cart',
969 'is_domain' => 1,
970 'is_contact' => 1,
971 'description' => 'WRITE ME',
972 'help_text' => 'WRITE ME',
973 ),
53ca8fd7 974 'monetaryThousandSeparator' => array(
50fb255d 975 'group_name' => 'Localization Preferences',
976 'group' => 'localization',
977 'name' => 'monetaryThousandSeparator',
978 'prefetch' => 1,
979 'config_only' => 1,
980 'type' => 'String',
981 'quick_form_type' => 'Element',
982 'html_type' => 'text',
983 'html_attributes' => array(
984 'size' => 2,
985 ),
986 'default' => ',',
987 'add' => '4.3',
988 'title' => 'Thousands Separator',
989 'is_domain' => 1,
990 'is_contact' => 0,
991 'description' => '',
992 'help_text' => '',
993 ),
53ca8fd7 994 'monetaryDecimalPoint' => array(
50fb255d 995 'group_name' => 'Localization Preferences',
996 'group' => 'localization',
997 'name' => 'monetaryDecimalPoint',
998 'prefetch' => 1,
999 'config_only' => 1,
1000 'type' => 'String',
1001 'quick_form_type' => 'Element',
1002 'html_type' => 'text',
1003 'html_attributes' => array(
1004 'size' => 2,
1005 ),
1006 'default' => '.',
1007 'add' => '4.3',
1008 'title' => 'Decimal Delimiter',
1009 'is_domain' => 1,
1010 'is_contact' => 0,
1011 'description' => '',
1012 'help_text' => '',
1013 ),
53ca8fd7 1014 'moneyformat' => array(
50fb255d 1015 'group_name' => 'Localization Preferences',
1016 'group' => 'localization',
1017 'name' => 'moneyformat',
1018 'prefetch' => 1,
1019 'config_only' => 1,
1020 'type' => 'String',
1021 'quick_form_type' => 'Element',
1022 'html_type' => 'text',
1023 'default' => '%c %a',
1024 'add' => '4.3',
1025 'title' => 'Monetary Amount Display',
1026 'is_domain' => 1,
1027 'is_contact' => 0,
1028 'description' => '',
1029 'help_text' => '',
1030 ),
53ca8fd7 1031 'moneyvalueformat' => array(
50fb255d 1032 'group_name' => 'Localization Preferences',
1033 'group' => 'localization',
1034 'name' => 'moneyvalueformat',
1035 'prefetch' => 1,
1036 'config_only' => 1,
1037 'type' => 'String',
1038 'quick_form_type' => 'Element',
1039 'html_type' => 'text',
1040 'default' => '%!i',
1041 'add' => '4.3',
1042 'title' => 'Monetary Amount Display',
1043 'is_domain' => 1,
1044 'is_contact' => 0,
1045 'description' => '',
1046 'help_text' => '',
1047 ),
53ca8fd7 1048 'defaultCurrency' => array(
50fb255d 1049 'group_name' => 'Localization Preferences',
1050 'group' => 'localization',
1051 'name' => 'defaultCurrency',
1052 'prefetch' => 1,
1053 'config_only' => 1,
1054 'type' => 'String',
1055 'quick_form_type' => 'Element',
1056 'html_type' => 'text',
1057 'html_attributes' => array(
1058 'size' => 2,
1059 ),
1060 'default' => 'USD',
1061 'add' => '4.3',
1062 'title' => 'Default Currency',
1063 'is_domain' => 1,
1064 'is_contact' => 0,
1065 'description' => 'Default currency assigned to contributions and other monetary transactions.',
1066 'help_text' => '',
1067 ),
b25fe59a 1068 'defaultContactCountry' => array(
50fb255d 1069 'group_name' => 'Localization Preferences',
1070 'group' => 'localization',
1071 'name' => 'defaultContactCountry',
1072 'prefetch' => 1,
1073 'config_only' => 1,
1074 'type' => 'String',
1075 'quick_form_type' => 'Element',
1076 'html_type' => 'text',
1077 'html_attributes' => array(
1078 'size' => 4,
1079 ),
1080 'default' => '1228',
1081 'add' => '4.4',
1082 'title' => 'Default Country',
1083 'is_domain' => 1,
1084 'is_contact' => 0,
1085 'description' => 'This value is selected by default when adding a new contact address.',
1086 'help_text' => '',
1087 ),
53ca8fd7 1088 'countryLimit' => array(
50fb255d 1089 'group_name' => 'Localization Preferences',
1090 'group' => 'localization',
1091 'name' => 'countryLimit',
1092 'prefetch' => 1,
1093 'config_only' => 1,
1094 'type' => 'Array',
1095 'quick_form_type' => 'Element',
1096 'html_type' => 'advmultiselect',
1097 'html_attributes' => array(
1098 'size' => 5,
1099 'style' => 'width:150px',
1100 'class' => 'advmultiselect',
1101 ),
1102 'default' => 'null',
1103 'add' => '4.3',
1104 'title' => 'Available Countries',
1105 'is_domain' => 1,
1106 'is_contact' => 0,
1107 'description' => '',
1108 'help_text' => '',
1109 ),
53ca8fd7 1110 'provinceLimit' => array(
50fb255d 1111 'group_name' => 'Localization Preferences',
1112 'group' => 'localization',
1113 'name' => 'provinceLimit',
1114 'prefetch' => 1,
1115 'config_only' => 1,
1116 'type' => 'Array',
1117 'quick_form_type' => 'Element',
1118 'html_type' => 'advmultiselect',
1119 'html_attributes' => array(
1120 'size' => 5,
1121 'style' => 'width:150px',
1122 'class' => 'advmultiselect',
1123 ),
1124 'default' => 'null',
1125 'add' => '4.3',
1126 'title' => 'Available States and Provinces',
1127 'is_domain' => 1,
1128 'is_contact' => 0,
1129 'description' => '',
1130 'help_text' => '',
1131 ),
53ca8fd7 1132 'inheritLocale' => array(
50fb255d 1133 'group_name' => 'Localization Preferences',
1134 'group' => 'localization',
1135 'name' => 'inheritLocale',
1136 'prefetch' => 1,
1137 'config_only' => 1,
1138 'type' => 'Boolean',
1139 'quick_form_type' => 'YesNo',
1140 'default' => 0,
1141 'add' => '4.3',
1142 'title' => 'Inherit CMS Language',
1143 'is_domain' => 1,
1144 'is_contact' => 0,
1145 'description' => '',
1146 'help_text' => '',
1147 ),
53ca8fd7 1148 'dateformatDatetime' => array(
50fb255d 1149 'group_name' => 'Localization Preferences',
1150 'group' => 'localization',
1151 'name' => 'dateformatDatetime',
1152 'prefetch' => 1,
1153 'config_only' => 1,
1154 'type' => 'String',
1155 'default' => '%B %E%f, %Y %l:%M %P',
1156 'add' => '4.3',
1157 'title' => 'Complete Date and Time',
1158 'is_domain' => 1,
1159 'is_contact' => 0,
1160 'description' => '',
1161 'help_text' => '',
1162 ),
53ca8fd7 1163 'dateformatFull' => array(
50fb255d 1164 'group_name' => 'Localization Preferences',
1165 'group' => 'localization',
1166 'name' => 'dateformatFull',
1167 'prefetch' => 1,
1168 'config_only' => 1,
1169 'type' => 'String',
1170 'default' => '%B %E%f, %Y',
1171 'add' => '4.3',
1172 'title' => 'Complete Date',
1173 'is_domain' => 1,
1174 'is_contact' => 0,
1175 'description' => '',
1176 'help_text' => '',
1177 ),
53ca8fd7 1178 'dateformatPartial' => array(
50fb255d 1179 'group_name' => 'Localization Preferences',
1180 'group' => 'localization',
1181 'name' => 'dateformatPartial',
1182 'prefetch' => 1,
1183 'config_only' => 1,
1184 'type' => 'String',
1185 'default' => '%B %Y',
1186 'add' => '4.3',
1187 'title' => 'Month and Year',
1188 'is_domain' => 1,
1189 'is_contact' => 0,
1190 'description' => '',
1191 'help_text' => '',
1192 ),
53ca8fd7 1193 'lcMessages' => array(
50fb255d 1194 'group_name' => 'Localization Preferences',
1195 'group' => 'localization',
1196 'name' => 'lcMessages',
1197 'prefetch' => 1,
1198 'config_only' => 1,
1199 'type' => 'String',
1200 'default' => 'en_US',
1201 'add' => '4.3',
1202 'title' => 'Default Language',
1203 'is_domain' => 1,
1204 'is_contact' => 0,
1205 'description' => '',
1206 'help_text' => '',
1207 ),
53ca8fd7 1208 'profile_double_optin' => array(
50fb255d 1209 'group_name' => 'Mailing Preferences',
1210 'group' => 'mailing',
1211 'name' => 'profile_double_optin',
1212 'type' => 'Integer',
1213 'html_type' => 'checkbox',
1214 'default' => 0,
1215 'add' => '4.1',
1216 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1217 'is_domain' => 1,
1218 'is_contact' => 0,
1219 '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.',
1220 'help_text' => '',
1221 ),
53ca8fd7 1222 'track_civimail_replies' => array(
50fb255d 1223 'group_name' => 'Mailing Preferences',
1224 'group' => 'mailing',
1225 'name' => 'track_civimail_replies',
1226 'type' => 'Integer',
1227 'html_type' => 'checkbox',
1228 'default' => 0,
1229 'add' => '4.1',
5c49fee0 1230 'title' => 'Track replies using VERP in Reply-To header',
50fb255d 1231 'is_domain' => 1,
1232 'is_contact' => 0,
5c49fee0 1233 'description' => 'If checked, mailings will default to tracking replies using VERP-ed Reply-To. ',
50fb255d 1234 'help_text' => '',
1235 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting',
1236 ),
53ca8fd7 1237 'civimail_workflow' => array(
50fb255d 1238 'group_name' => 'Mailing Preferences',
1239 'group' => 'mailing',
1240 'name' => 'civimail_workflow',
1241 'type' => 'Integer',
1242 'html_type' => 'checkbox',
1243 'default' => 0,
1244 'add' => '4.1',
1245 'title' => 'Use CiviMail Workflow',
1246 'is_domain' => 1,
1247 'is_contact' => 0,
1248 '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.',
1249 'help_text' => '',
1250 ),
53ca8fd7 1251 'civimail_server_wide_lock' => array(
50fb255d 1252 'group_name' => 'Mailing Preferences',
1253 'group' => 'mailing',
1254 'name' => 'civimail_server_wide_lock',
1255 'type' => 'Integer',
1256 'html_type' => 'checkbox',
1257 'default' => 0,
1258 'add' => '4.1',
1259 'title' => 'Lock Mails Server-Wide for Mail Sending',
1260 'is_domain' => 1,
1261 'is_contact' => 0,
1262 'description' => '',
1263 'help_text' => '',
1264 ),
53ca8fd7 1265 'mailing_backend' => array(
50fb255d 1266 'group_name' => 'Mailing Preferences',
1267 'group' => 'mailing',
1268 'name' => 'mailing_backend',
1269 'type' => 'Array',
1270 'html_type' => 'checkbox',
1271 'default' => 0,
1272 'add' => '4.1',
1273 'title' => 'Mailing Backend',
1274 'is_domain' => 1,
1275 'is_contact' => 0,
1276 'description' => '',
1277 'help_text' => '',
1278 ),
53ca8fd7 1279 'profile_add_to_group_double_optin' => array(
50fb255d 1280 'group_name' => 'Mailing Preferences',
1281 'group' => 'mailing',
1282 'name' => 'profile_add_to_group_double_optin',
1283 'type' => 'Integer',
1284 'html_type' => 'checkbox',
1285 'default' => 0,
1286 'add' => '4.1',
1287 'title' => 'Enable Double Opt-in for Profile Group(s) field',
1288 'is_domain' => 1,
1289 'is_contact' => 0,
1290 '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.',
1291 'help_text' => '',
1292 ),
b25fe59a 1293 'disable_mandatory_tokens_check' => array(
50fb255d 1294 'group_name' => 'Mailing Preferences',
1295 'group' => 'mailing',
1296 'name' => 'disable_mandatory_tokens_check',
1297 'type' => 'Integer',
1298 'html_type' => 'checkbox',
1299 'default' => 0,
1300 'add' => '4.4',
1301 'title' => 'Disable check for mandatory tokens',
1302 'is_domain' => 1,
1303 'is_contact' => 0,
1304 '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.',
1305 'help_text' => '',
1306 ),
89bf81b4 1307 'dedupe_email_default' => array(
50fb255d 1308 'group_name' => 'Mailing Preferences',
1309 'group' => 'mailing',
1310 'name' => 'dedupe_email_default',
1311 'type' => 'Integer',
1312 'html_type' => 'checkbox',
1313 'default' => 1,
1314 'add' => '4.5',
1315 'title' => 'CiviMail dedupes e-mail addresses by default',
1316 'is_domain' => 1,
1317 'is_contact' => 0,
1318 'description' => 'Set the \"dedupe e-mail\" option when sending a new mailing to \"true\" by default.',
1319 'help_text' => '',
1320 ),
89bf81b4 1321 'hash_mailing_url' => array(
50fb255d 1322 'group_name' => 'Mailing Preferences',
1323 'group' => 'mailing',
1324 'name' => 'hash_mailing_url',
1325 'type' => 'Integer',
1326 'html_type' => 'checkbox',
1327 'default' => 0,
1328 'add' => '4.5',
1329 'title' => 'Hashed Mailing URL\'s',
1330 'is_domain' => 1,
1331 'is_contact' => 0,
1332 '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',
1333 'help_text' => '',
1334 ),
53ca8fd7 1335 'default_renewal_contribution_page' => array(
50fb255d 1336 'group_name' => 'Member Preferences',
1337 'group' => 'member',
1338 'name' => 'default_renewal_contribution_page',
1339 'type' => 'Integer',
1340 'html_type' => 'Select',
1341 'default' => '',
1342 'pseudoconstant' => array(
1343 'name' => 'contributionPage',
1344 ),
1345 'add' => '4.1',
1346 'title' => 'Default online membership renewal page',
1347 'is_domain' => 1,
1348 'is_contact' => 0,
1349 '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.',
1350 'help_text' => '',
1351 ),
53ca8fd7 1352 'is_enabled' => array(
50fb255d 1353 'group_name' => 'Multi Site Preferences',
1354 'group' => 'multisite',
1355 'name' => 'is_enabled',
1356 'title' => 'Multisite Is enabled',
1357 'type' => 'Integer',
1358 'default' => '',
1359 'add' => '4.1',
1360 'is_domain' => 1,
1361 'is_contact' => 0,
1362 'description' => 'Multisite is enabled',
1363 'help_text' => '',
1364 ),
53ca8fd7 1365 'domain_group_id' => array(
50fb255d 1366 'group_name' => 'Multi Site Preferences',
1367 'group' => 'multisite',
1368 'name' => 'domain_group_id',
1369 'title' => 'Multisite Domain Group',
1370 'type' => 'Integer',
1371 'default' => '',
1372 'add' => '4.1',
1373 'is_domain' => 1,
1374 'is_contact' => 0,
1375 'description' => '',
1376 'help_text' => '',
1377 ),
53ca8fd7 1378 'event_price_set_domain_id' => array(
50fb255d 1379 'group_name' => 'Multi Site Preferences',
1380 'group' => 'multisite',
1381 'name' => 'event_price_set_domain_id',
1382 'title' => 'Domain Event Price Set',
1383 'type' => 'Integer',
1384 'default' => '',
1385 'add' => '4.1',
1386 'is_domain' => 1,
1387 'is_contact' => 0,
1388 'description' => '',
1389 'help_text' => '',
1390 ),
53ca8fd7 1391 'uniq_email_per_site' => array(
50fb255d 1392 'group_name' => 'Multi Site Preferences',
1393 'group' => 'multisite',
1394 'name' => 'uniq_email_per_site',
1395 'type' => 'Integer',
1396 'title' => 'Unique Email per Domain?',
1397 'default' => '',
1398 'add' => '4.1',
1399 'is_domain' => 1,
1400 'is_contact' => 0,
1401 'description' => '',
1402 'help_text' => '',
1403 ),
53ca8fd7 1404 'search_autocomplete_count' => array(
50fb255d 1405 'group_name' => 'Search Preferences',
1406 'group' => 'Search Preferences',
1407 'name' => 'search_autocomplete_count',
1408 'prefetch' => 0,
1409 'type' => 'Integer',
1410 'quick_form_type' => 'Element',
1411 'html_type' => 'text',
1412 'html_attributes' => array(
1413 'size' => 2,
1414 'maxlength' => 2,
1415 ),
1416 'default' => 10,
1417 'add' => '4.3',
1418 'title' => 'Autocomplete Results',
1419 'is_domain' => 1,
1420 'is_contact' => 0,
1421 'description' => 'The maximum number of contacts to show at a time when typing in an autocomplete field.',
1422 'help_text' => '',
1423 ),
89bf81b4 1424 'enable_innodb_fts' => array(
50fb255d 1425 'group_name' => 'Search Preferences',
1426 'group' => 'Search Preferences',
1427 'name' => 'enable_innodb_fts',
1428 'prefetch' => 0,
1429 'type' => 'Boolean',
1430 'quick_form_type' => 'YesNo',
1431 'default' => 0,
1432 'add' => '4.4',
1433 'title' => 'InnoDB Full Text Search',
1434 'is_domain' => 1,
1435 'is_contact' => 0,
1436 'description' => 'Enable InnoDB full-text search optimizations. (Requires MySQL 5.6+)',
1437 'help_text' => '',
1438 'on_change' => array(
1439 '0' => array(
1440 '0' => 'CRM_Core_InnoDBIndexer',
1441 '1' => 'onToggleFts',
1442 ),
1443 ),
1444 ),
89bf81b4 1445 'fts_query_mode' => array(
50fb255d 1446 'group_name' => 'Search Preferences',
1447 'group' => 'Search Preferences',
1448 'name' => 'fts_query_mode',
1449 'prefetch' => 0,
1450 'type' => 'String',
1451 'quick_form_type' => 'Element',
50fb255d 1452 'html_attributes' => array(
1453 'size' => 64,
1454 'maxlength' => 64,
1455 ),
5c49fee0 1456 'html_type' => 'Text',
50fb255d 1457 'default' => 'simple',
1458 'add' => '4.5',
1459 'title' => 'How to handle full-tet queries',
1460 'is_domain' => 1,
1461 'is_contact' => 0,
1462 'description' => '',
1463 'help_text' => '',
1464 ),
53ca8fd7 1465 'userFrameworkResourceURL' => array(
50fb255d 1466 'group' => 'url',
1467 'group_name' => 'URL Preferences',
1468 'name' => 'userFrameworkResourceURL',
1469 'title' => 'Script and CSS Resources URL',
1470 'type' => 'String',
1471 'default' => '',
1472 'add' => '4.1',
1473 'prefetch' => 1,
1474 'is_domain' => 1,
1475 'is_contact' => 0,
1476 'description' => 'CiviCRM Resource URL',
1477 'help_text' => '',
1478 'validate_callback' => 'CRM_Utils_Rule::url',
1479 ),
53ca8fd7 1480 'imageUploadURL' => array(
50fb255d 1481 'group' => 'url',
1482 'group_name' => 'URL Preferences',
1483 'title' => 'Image URL Prefix',
1484 'name' => 'imageUploadURL',
1485 'type' => 'String',
1486 'default' => '',
1487 'add' => '4.1',
1488 'prefetch' => 1,
1489 'is_domain' => 1,
1490 'is_contact' => 0,
1491 'description' => 'Image Upload URL',
1492 'help_text' => '',
1493 'validate_callback' => 'CRM_Utils_Rule::url',
1494 ),
53ca8fd7 1495 'customCSSURL' => array(
50fb255d 1496 'group' => 'url',
1497 'group_name' => 'URL Preferences',
1498 'name' => 'customCSSURL',
1499 'title' => 'Custom CSS',
1500 'type' => 'String',
1501 'default' => '',
1502 'add' => '4.1',
1503 'prefetch' => 1,
1504 'is_domain' => 1,
1505 'is_contact' => 0,
1506 'description' => 'Custom CiviCRM CSS URL',
1507 'help_text' => '',
1508 'validate_callback' => 'CRM_Utils_Rule::url',
1509 ),
6a488035 1510 ),
50fb255d 1511 );
6a488035 1512
fb32de45 1513 return $expectedResult;
6a488035
TO
1514}
1515
a828d7b8 1516/*
50fb255d 1517* This example has been generated from the API test suite.
a828d7b8
CW
1518* The test that created it is called "testGetFields"
1519* and can be found at:
69d79249 1520* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
6a488035
TO
1521*
1522* You can see the outcome of the API tests at
69d79249 1523* https://test.civicrm.org/job/CiviCRM-master-git/
6a488035
TO
1524*
1525* To Learn about the API read
69d79249 1526* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
6a488035 1527*
69d79249 1528* Browse the api on your own site with the api explorer
41d4d31f 1529* http://MYSITE.ORG/path/to/civicrm/api
6a488035
TO
1530*
1531* Read more about testing here
1532* http://wiki.civicrm.org/confluence/display/CRM/Testing
1533*
1534* API Standards documentation:
1535* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
b25fe59a 1536*/