Flag that Embedded Activity Revisions setting is unsupported and deprecated
[civicrm-core.git] / api / v3 / examples / Setting / GetFields.ex.php
1 <?php
2 /**
3 * Test Generated example demonstrating the Setting.getfields API.
4 *
5 * Demonstrate return from getfields - see subfolder for variants
6 *
7 * @return array
8 * API result array
9 */
10 function setting_getfields_example() {
11 $params = [];
12
13 try{
14 $result = civicrm_api3('Setting', 'getfields', $params);
15 }
16 catch (CiviCRM_API3_Exception $e) {
17 // Handle error here.
18 $errorMessage = $e->getMessage();
19 $errorCode = $e->getErrorCode();
20 $errorData = $e->getExtraParams();
21 return [
22 'is_error' => 1,
23 'error_message' => $errorMessage,
24 'error_code' => $errorCode,
25 'error_data' => $errorData,
26 ];
27 }
28
29 return $result;
30 }
31
32 /**
33 * Function returns array of result expected from previous function.
34 *
35 * @return array
36 * API result array
37 */
38 function setting_getfields_expectedresult() {
39
40 $expectedResult = [
41 'is_error' => 0,
42 'version' => 3,
43 'count' => 173,
44 'values' => [
45 'address_standardization_provider' => [
46 'group_name' => 'Address Preferences',
47 'group' => 'address',
48 'name' => 'address_standardization_provider',
49 'type' => 'String',
50 'html_type' => 'select',
51 'default' => '',
52 'add' => '4.1',
53 'title' => 'Address Standardization Provider.',
54 'pseudoconstant' => [
55 'callback' => 'CRM_Core_SelectValues::addressProvider',
56 ],
57 'is_domain' => 1,
58 'is_contact' => 0,
59 'description' => '',
60 '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. ',
61 ],
62 'address_standardization_userid' => [
63 'group_name' => 'Address Preferences',
64 'group' => 'address',
65 'name' => 'address_standardization_userid',
66 'type' => 'String',
67 'html_type' => 'text',
68 'default' => '',
69 'add' => '4.1',
70 'title' => 'Provider service user ID',
71 'is_domain' => 1,
72 'is_contact' => 0,
73 'description' => '',
74 'help_text' => '',
75 ],
76 'address_standardization_url' => [
77 'group_name' => 'Address Preferences',
78 'group' => 'address',
79 'name' => 'address_standardization_url',
80 'type' => 'Text',
81 'html_type' => 'text',
82 'default' => '',
83 'add' => '4.1',
84 'title' => 'Provider Service URL',
85 'is_domain' => 1,
86 'is_contact' => 0,
87 'description' => '',
88 'help_text' => 'Web Service URL',
89 'validate_callback' => 'CRM_Utils_Rule::url',
90 ],
91 'hideCountryMailingLabels' => [
92 'group_name' => 'Address Preferences',
93 'group' => 'address',
94 'name' => 'hideCountryMailingLabels',
95 'type' => 'Boolean',
96 'quick_form_type' => 'YesNo',
97 'default' => 0,
98 'add' => '4.7',
99 'title' => 'Hide Country in Mailing Labels when same as domain country',
100 'is_domain' => 1,
101 'is_contact' => 0,
102 'description' => 'Do not display the country field in mailing labels when the country is the same as that of the domain',
103 'help_text' => '',
104 ],
105 'tag_unconfirmed' => [
106 'group_name' => 'Campaign Preferences',
107 'group' => 'campaign',
108 'name' => 'tag_unconfirmed',
109 'type' => 'String',
110 'html_type' => 'text',
111 'default' => 'Unconfirmed',
112 'add' => '4.1',
113 'title' => 'Tag for Unconfirmed Petition Signers',
114 'is_domain' => 1,
115 'is_contact' => 0,
116 'description' => 'If set, new contacts that are created when signing a petition are assigned a tag of this name.',
117 'help_text' => '',
118 'settings_pages' => [
119 'campaign' => [
120 'weight' => 10,
121 ],
122 ],
123 ],
124 'petition_contacts' => [
125 'group_name' => 'Campaign Preferences',
126 'group' => 'campaign',
127 'name' => 'petition_contacts',
128 'type' => 'String',
129 'html_type' => 'text',
130 'default' => 'Petition Contacts',
131 'add' => '4.1',
132 'title' => 'Petition Signers Group',
133 'is_domain' => 1,
134 'is_contact' => 0,
135 'description' => 'All contacts that have signed a CiviCampaign petition will be added to this group. The group will be created if it does not exist (it is required for email verification).',
136 'help_text' => '',
137 'settings_pages' => [
138 'campaign' => [
139 'weight' => 20,
140 ],
141 ],
142 ],
143 'civicaseRedactActivityEmail' => [
144 'group_name' => 'CiviCRM Preferences',
145 'group' => 'core',
146 'name' => 'civicaseRedactActivityEmail',
147 'type' => 'String',
148 'quick_form_type' => 'Select',
149 'html_type' => 'Select',
150 'html_attributes' => [],
151 'default' => 'default',
152 'add' => '4.7',
153 'title' => 'Redact Activity Email',
154 'is_domain' => 1,
155 'is_contact' => 0,
156 'pseudoconstant' => [
157 'callback' => 'CRM_Case_Info::getRedactOptions',
158 ],
159 'description' => 'Should activity emails be redacted? (Set \"Default\" to load setting from the legacy \"Settings.xml\" file.)',
160 'help_text' => '',
161 ],
162 'civicaseAllowMultipleClients' => [
163 'group_name' => 'CiviCRM Preferences',
164 'group' => 'core',
165 'name' => 'civicaseAllowMultipleClients',
166 'type' => 'String',
167 'quick_form_type' => 'Select',
168 'html_type' => 'Select',
169 'html_attributes' => [],
170 'default' => 'default',
171 'add' => '4.7',
172 'title' => 'Allow Multiple Case Clients',
173 'is_domain' => 1,
174 'is_contact' => 0,
175 'pseudoconstant' => [
176 'callback' => 'CRM_Case_Info::getMultiClientOptions',
177 ],
178 'description' => 'How many clients may be associated with a given case? (Set \"Default\" to load setting from the legacy \"Settings.xml\" file.)',
179 'help_text' => '',
180 ],
181 'civicaseNaturalActivityTypeSort' => [
182 'group_name' => 'CiviCRM Preferences',
183 'group' => 'core',
184 'name' => 'civicaseNaturalActivityTypeSort',
185 'type' => 'String',
186 'quick_form_type' => 'Select',
187 'html_type' => 'Select',
188 'html_attributes' => [],
189 'default' => 'default',
190 'add' => '4.7',
191 'title' => 'Activity Type Sorting',
192 'is_domain' => 1,
193 'is_contact' => 0,
194 'pseudoconstant' => [
195 'callback' => 'CRM_Case_Info::getSortOptions',
196 ],
197 'description' => 'How to sort activity-types on the \"Manage Case\" screen? (Set \"Default\" to load setting from the legacy \"Settings.xml\" file.)',
198 'help_text' => '',
199 ],
200 'civicaseActivityRevisions' => [
201 'group_name' => 'CiviCRM Preferences',
202 'group' => 'core',
203 'name' => 'civicaseActivityRevisions',
204 'type' => 'Boolean',
205 'quick_form_type' => 'YesNo',
206 'default' => '',
207 'html_type' => 'radio',
208 'add' => '4.7',
209 'title' => 'Enable deprecated Embedded Activity Revisions',
210 'is_domain' => 1,
211 'is_contact' => 0,
212 'description' => 'Enable tracking of activity revisions embedded within the \"civicrm_activity\" table. Alternatively, see \"Administer => System Settings => Misc => Logging\".',
213 'help_text' => '',
214 ],
215 'cvv_backoffice_required' => [
216 'group_name' => 'Contribute Preferences',
217 'group' => 'contribute',
218 'name' => 'cvv_backoffice_required',
219 'type' => 'Boolean',
220 'html_type' => 'radio',
221 'quick_form_type' => 'YesNo',
222 'default' => '1',
223 'add' => '4.1',
224 'title' => 'CVV required for backoffice?',
225 'is_domain' => 1,
226 'is_contact' => 0,
227 'description' => 'Is the CVV code required for back office credit card transactions',
228 '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',
229 ],
230 'contribution_invoice_settings' => [
231 'group_name' => 'Contribute Preferences',
232 'group' => 'contribute',
233 'name' => 'contribution_invoice_settings',
234 'type' => 'Array',
235 'default' => [
236 'invoice_prefix' => 'INV_',
237 'due_date' => '10',
238 'due_date_period' => 'days',
239 'notes' => '',
240 'tax_term' => 'Sales Tax',
241 'tax_display_settings' => 'Inclusive',
242 ],
243 'add' => '4.7',
244 'title' => 'Contribution Invoice Settings',
245 'is_domain' => 1,
246 'is_contact' => 0,
247 'description' => '',
248 'help_text' => '',
249 ],
250 'invoicing' => [
251 'group_name' => 'Contribute Preferences',
252 'group' => 'contribute',
253 'name' => 'invoicing',
254 'type' => 'Boolean',
255 'html_type' => 'checkbox',
256 'quick_form_type' => 'Element',
257 'default' => 0,
258 'add' => '4.7',
259 'title' => 'Enable Tax and Invoicing',
260 'is_domain' => 1,
261 'is_contact' => 0,
262 'on_change' => [
263 '0' => 'CRM_Invoicing_Utils::onToggle',
264 ],
265 ],
266 'acl_financial_type' => [
267 'group_name' => 'Contribute Preferences',
268 'group' => 'contribute',
269 'name' => 'acl_financial_type',
270 'type' => 'Boolean',
271 'html_type' => 'checkbox',
272 'quick_form_type' => 'Element',
273 'default' => 0,
274 'add' => '4.7',
275 'title' => 'Enable Access Control by Financial Type',
276 'is_domain' => 1,
277 'is_contact' => 0,
278 'description' => '',
279 'help_text' => '',
280 'help' => [
281 'id' => 'acl_financial_type',
282 ],
283 ],
284 'deferred_revenue_enabled' => [
285 'group_name' => 'Contribute Preferences',
286 'group' => 'contribute',
287 'name' => 'deferred_revenue_enabled',
288 'type' => 'Boolean',
289 'html_type' => 'checkbox',
290 'quick_form_type' => 'Element',
291 'default' => 0,
292 'add' => '4.7',
293 'title' => 'Enable Deferred Revenue',
294 'is_domain' => 1,
295 'is_contact' => 0,
296 'description' => '',
297 'help_text' => '',
298 ],
299 'default_invoice_page' => [
300 'group_name' => 'Contribute Preferences',
301 'group' => 'contribute',
302 'name' => 'default_invoice_page',
303 'type' => 'Integer',
304 'quick_form_type' => 'Select',
305 'default' => '',
306 'pseudoconstant' => [
307 'callback' => 'CRM_Contribute_PseudoConstant::contributionPage',
308 ],
309 'html_type' => 'select',
310 'add' => '4.7',
311 'title' => 'Default invoice payment page',
312 'is_domain' => 1,
313 'is_contact' => 0,
314 'description' => '',
315 'help_text' => '',
316 ],
317 'always_post_to_accounts_receivable' => [
318 'group_name' => 'Contribute Preferences',
319 'group' => 'contribute',
320 'name' => 'always_post_to_accounts_receivable',
321 'type' => 'Boolean',
322 'html_type' => 'checkbox',
323 'quick_form_type' => 'Element',
324 'default' => 0,
325 'add' => '4.7',
326 'title' => 'Always post to Accounts Receivable?',
327 'is_domain' => 1,
328 'is_contact' => 0,
329 'description' => '',
330 'help_text' => '',
331 ],
332 'update_contribution_on_membership_type_change' => [
333 'group_name' => 'Contribute Preferences',
334 'group' => 'contribute',
335 'name' => 'update_contribution_on_membership_type_change',
336 'type' => 'Boolean',
337 'html_type' => 'checkbox',
338 'quick_form_type' => 'Element',
339 'default' => 0,
340 'add' => '4.7',
341 'title' => 'Automatically update related contributions when Membership Type is changed',
342 'is_domain' => 1,
343 'is_contact' => 0,
344 'description' => 'Enabling this setting will update related contribution of membership(s) except if the membership is paid for with a recurring contribution.',
345 'help_text' => '',
346 ],
347 'contact_view_options' => [
348 'group_name' => 'CiviCRM Preferences',
349 'group' => 'core',
350 'name' => 'contact_view_options',
351 'type' => 'String',
352 'html_type' => 'checkboxes',
353 'pseudoconstant' => [
354 'optionGroupName' => 'contact_view_options',
355 ],
356 'default' => '\ 11\ 12\ 13\ 14\ 15\ 16\ 17\ 18\ 19\ 110\ 111\ 113\ 1',
357 'add' => '4.1',
358 'title' => 'Viewing Contacts',
359 'is_domain' => '1',
360 'is_contact' => 0,
361 'description' => 'Select the tabs that should be displayed when viewing a contact record. EXAMPLE: If your organization does not keep track of \'Relationships\', then un-check this option to simplify the screen display. Tabs for Contributions, Pledges, Memberships, Events, Grants and Cases are also hidden if the corresponding component is not enabled. Go to Administer > System Settings > Enable Components to modify the components which are available for your site.',
362 'help_text' => '',
363 'serialize' => 1,
364 ],
365 'contact_edit_options' => [
366 'group_name' => 'CiviCRM Preferences',
367 'group' => 'core',
368 'name' => 'contact_edit_options',
369 'type' => 'String',
370 'html_type' => 'checkboxes',
371 'pseudoconstant' => [
372 'optionGroupName' => 'contact_edit_options',
373 ],
374 'default' => '\ 11\ 12\ 13\ 14\ 15\ 16\ 17\ 18\ 19\ 111\ 112\ 114\ 115\ 116\ 117\ 1',
375 'add' => '4.1',
376 'title' => 'Editing Contacts',
377 'is_domain' => 1,
378 'is_contact' => 0,
379 'description' => 'Select the sections that should be included when adding or editing a contact record. EXAMPLE: If your organization does not record Gender and Birth Date for individuals, then simplify the form by un-checking this option. Drag interface allows you to change the order of the panes displayed on contact add/edit screen.',
380 'help_text' => '',
381 'serialize' => 1,
382 ],
383 'advanced_search_options' => [
384 'group_name' => 'CiviCRM Preferences',
385 'group' => 'core',
386 'name' => 'advanced_search_options',
387 'type' => 'String',
388 'html_type' => 'checkboxes',
389 'pseudoconstant' => [
390 'optionGroupName' => 'advanced_search_options',
391 ],
392 'default' => '\ 11\ 12\ 13\ 14\ 15\ 16\ 17\ 18\ 19\ 110\ 111\ 112\ 113\ 115\ 116\ 117\ 118\ 119\ 1',
393 'add' => '4.1',
394 'title' => 'Contact Search',
395 'is_domain' => 1,
396 'is_contact' => 0,
397 'description' => 'Select the sections that should be included in the Basic and Advanced Search forms. EXAMPLE: If you don\'t track Relationships - then you do not need this section included in the advanced search form. Simplify the form by un-checking this option.',
398 'serialize' => 1,
399 ],
400 'user_dashboard_options' => [
401 'group_name' => 'CiviCRM Preferences',
402 'group' => 'core',
403 'name' => 'user_dashboard_options',
404 'type' => 'String',
405 'html_type' => 'checkboxes',
406 'pseudoconstant' => [
407 'optionGroupName' => 'user_dashboard_options',
408 ],
409 'default' => '\ 11\ 12\ 13\ 14\ 15\ 17\ 18\ 1',
410 'add' => '4.1',
411 'title' => 'Contact Dashboard',
412 'is_domain' => 1,
413 'is_contact' => 0,
414 'description' => 'Select the sections that should be included in the Contact Dashboard. EXAMPLE: If you don\'t want constituents to view their own contribution history, un-check that option.',
415 'help_text' => '',
416 'serialize' => 1,
417 ],
418 'address_options' => [
419 'group_name' => 'CiviCRM Preferences',
420 'group' => 'core',
421 'name' => 'address_options',
422 'type' => 'String',
423 'html_type' => 'checkboxes',
424 'pseudoconstant' => [
425 'optionGroupName' => 'address_options',
426 ],
427 'default' => '\ 11\ 12\ 13\ 14\ 15\ 16\ 18\ 19\ 110\ 111\ 1',
428 'add' => '4.1',
429 'title' => 'Address Fields',
430 'is_domain' => 1,
431 'is_contact' => 0,
432 'description' => '',
433 'help_text' => '',
434 'serialize' => 1,
435 ],
436 'address_format' => [
437 'group_name' => 'CiviCRM Preferences',
438 'group' => 'core',
439 'name' => 'address_format',
440 'type' => 'String',
441 'html_type' => 'textarea',
442 'default' => '{contact.address_name}
443 {contact.street_address}
444 {contact.supplemental_address_1}
445 {contact.supplemental_address_2}
446 {contact.supplemental_address_3}
447 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
448 {contact.country}',
449 'add' => '4.1',
450 'title' => 'Address Display Format',
451 'is_domain' => 1,
452 'is_contact' => 0,
453 'description' => '',
454 'help_text' => '',
455 ],
456 'mailing_format' => [
457 'group_name' => 'CiviCRM Preferences',
458 'group' => 'core',
459 'name' => 'mailing_format',
460 'type' => 'String',
461 'html_type' => 'textarea',
462 'default' => '{contact.addressee}
463 {contact.street_address}
464 {contact.supplemental_address_1}
465 {contact.supplemental_address_2}
466 {contact.supplemental_address_3}
467 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
468 {contact.country}',
469 'add' => '4.1',
470 'title' => 'Mailing Label Format',
471 'is_domain' => 1,
472 'is_contact' => 0,
473 'description' => '',
474 'help_text' => '',
475 ],
476 'display_name_format' => [
477 'group_name' => 'CiviCRM Preferences',
478 'group' => 'core',
479 'name' => 'display_name_format',
480 'type' => 'String',
481 'html_type' => 'textarea',
482 'default' => '{contact.individual_prefix}{ }{contact.first_name}{ }{contact.last_name}{ }{contact.individual_suffix}',
483 'add' => '4.1',
484 'title' => 'Individual Display Name Format',
485 'is_domain' => 1,
486 'is_contact' => 0,
487 'description' => 'Display name format for individual contact display names.',
488 ],
489 'sort_name_format' => [
490 'group_name' => 'CiviCRM Preferences',
491 'group' => 'core',
492 'name' => 'sort_name_format',
493 'type' => 'String',
494 'html_type' => 'textarea',
495 'default' => '{contact.last_name}{, }{contact.first_name}',
496 'add' => '4.1',
497 'title' => 'Individual Sort Name Format',
498 'is_domain' => 1,
499 'is_contact' => 0,
500 'description' => 'Sort name format for individual contact display names.',
501 ],
502 'remote_profile_submissions' => [
503 'group_name' => 'CiviCRM Preferences',
504 'group' => 'core',
505 'name' => 'remote_profile_submissions',
506 'type' => 'Boolean',
507 'quick_form_type' => 'YesNo',
508 'default' => '',
509 'html_type' => 'radio',
510 'add' => '4.7',
511 'title' => 'Accept profile submissions from external sites',
512 'is_domain' => 1,
513 'is_contact' => 0,
514 'description' => 'If enabled, CiviCRM will permit submissions from external sites to profiles. This is disabled by default to limit abuse.',
515 'help_text' => '',
516 ],
517 'allow_alert_autodismissal' => [
518 'group_name' => 'CiviCRM Preferences',
519 'group' => 'core',
520 'name' => 'allow_alert_autodismissal',
521 'type' => 'Boolean',
522 'quick_form_type' => 'YesNo',
523 'default' => TRUE,
524 'html_type' => 'radio',
525 'add' => '4.7',
526 'title' => 'Allow alerts to auto-dismiss?',
527 'is_domain' => 1,
528 'is_contact' => 0,
529 'description' => 'If disabled, CiviCRM will not automatically dismiss any alerts after 10 seconds.',
530 'help_text' => '',
531 ],
532 'editor_id' => [
533 'group_name' => 'CiviCRM Preferences',
534 'group' => 'core',
535 'name' => 'editor_id',
536 'type' => 'String',
537 'html_type' => 'select',
538 'default' => 'CKEditor',
539 'add' => '4.1',
540 'title' => 'Wysiwig Editor',
541 'pseudoconstant' => [
542 'optionGroupName' => 'wysiwyg_editor',
543 'keyColumn' => 'name',
544 ],
545 'is_domain' => 1,
546 'is_contact' => 0,
547 'description' => '',
548 'help_text' => '',
549 ],
550 'contact_ajax_check_similar' => [
551 'group_name' => 'CiviCRM Preferences',
552 'group' => 'core',
553 'name' => 'contact_ajax_check_similar',
554 'type' => 'String',
555 'html_type' => 'radio',
556 'default' => '1',
557 'add' => '4.1',
558 'title' => 'Check for Similar Contacts',
559 'is_domain' => 1,
560 'is_contact' => 0,
561 'description' => '',
562 'help_text' => '',
563 'options' => [
564 '1' => 'While Typing',
565 '0' => 'When Saving',
566 '2' => 'Never',
567 ],
568 ],
569 'ajaxPopupsEnabled' => [
570 'group_name' => 'CiviCRM Preferences',
571 'group' => 'core',
572 'name' => 'ajaxPopupsEnabled',
573 'type' => 'Boolean',
574 'html_type' => 'checkbox',
575 'default' => 1,
576 'add' => '4.5',
577 'title' => 'Enable Popup Forms',
578 'is_domain' => 1,
579 'is_contact' => 0,
580 'description' => '',
581 'help_text' => '',
582 ],
583 'activity_assignee_notification' => [
584 'group_name' => 'CiviCRM Preferences',
585 'group' => 'core',
586 'name' => 'activity_assignee_notification',
587 'type' => 'Boolean',
588 'html_type' => 'checkbox',
589 'default' => '1',
590 'add' => '4.1',
591 'title' => 'Notify Activity Assignees',
592 'is_domain' => 1,
593 'is_contact' => 0,
594 'description' => '',
595 'help_text' => '',
596 ],
597 'activity_assignee_notification_ics' => [
598 'group_name' => 'CiviCRM Preferences',
599 'group' => 'core',
600 'name' => 'activity_assignee_notification_ics',
601 'type' => 'Boolean',
602 'html_type' => 'checkbox',
603 'default' => 0,
604 'add' => '4.3',
605 'title' => 'Include ICal Invite to Activity Assignees',
606 'is_domain' => 1,
607 'is_contact' => 0,
608 'description' => '',
609 'help_text' => '',
610 ],
611 'contact_autocomplete_options' => [
612 'group_name' => 'CiviCRM Preferences',
613 'group' => 'core',
614 'name' => 'contact_autocomplete_options',
615 'type' => 'String',
616 'html_type' => 'checkboxes',
617 'pseudoconstant' => [
618 'callback' => 'CRM_Admin_Form_Setting_Search::getContactAutocompleteOptions',
619 ],
620 'default' => '\ 11\ 12\ 1',
621 'add' => '4.1',
622 'title' => 'Autocomplete Contact Search',
623 'is_domain' => 1,
624 'is_contact' => 0,
625 'description' => 'Selected fields will be displayed in back-office autocomplete dropdown search results (Quick Search, etc.). Contact Name is always included.',
626 'help_text' => '',
627 'serialize' => 1,
628 'validate_callback' => 'CRM_Admin_Form_Setting_Search::enableOptionOne',
629 ],
630 'contact_reference_options' => [
631 'group_name' => 'CiviCRM Preferences',
632 'group' => 'core',
633 'name' => 'contact_reference_options',
634 'type' => 'String',
635 'html_type' => 'checkboxes',
636 'pseudoconstant' => [
637 'callback' => 'CRM_Admin_Form_Setting_Search::getContactReferenceOptions',
638 ],
639 'default' => '\ 11\ 12\ 1',
640 'add' => '4.1',
641 'title' => 'Contact Reference Options',
642 'is_domain' => 1,
643 'is_contact' => 0,
644 'description' => 'Selected fields will be displayed in autocomplete dropdown search results for \'Contact Reference\' custom fields. Contact Name is always included. NOTE: You must assign \'access contact reference fields\' permission to the anonymous role if you want to use custom contact reference fields in profiles on public pages. For most situations, you should use the \'Limit List to Group\' setting when configuring a contact reference field which will be used in public forms to prevent exposing your entire contact list.',
645 'help_text' => '',
646 'serialize' => 1,
647 'validate_callback' => 'CRM_Admin_Form_Setting_Search::enableOptionOne',
648 ],
649 'contact_smart_group_display' => [
650 'group_name' => 'CiviCRM Preferences',
651 'group' => 'core',
652 'name' => 'contact_smart_group_display',
653 'type' => 'String',
654 'html_type' => 'radio',
655 'default' => '1',
656 'add' => '4.7',
657 'title' => 'Viewing Smart Groups',
658 'is_domain' => 1,
659 'is_contact' => 0,
660 'description' => 'Controls display of the smart groups that a contact is part of in each contact\'s \"Groups\" tab. \"Show on Demand\" provides the best performance, and is recommended for most sites.',
661 'help_text' => '',
662 'pseudoconstant' => [
663 'optionGroupName' => 'contact_smart_group_display',
664 ],
665 ],
666 'smart_group_cache_refresh_mode' => [
667 'group_name' => 'CiviCRM Preferences',
668 'group' => 'core',
669 'name' => 'smart_group_cache_refresh_mode',
670 'type' => 'String',
671 'html_type' => 'radio',
672 'default' => 'opportunistic',
673 'add' => '4.7',
674 'title' => 'Smart Group Refresh Mode',
675 'is_domain' => 1,
676 'is_contact' => 0,
677 'pseudoconstant' => [
678 'callback' => 'CRM_Contact_BAO_GroupContactCache::getModes',
679 ],
680 'description' => 'Should the smart groups be by cron jobs or user actions',
681 'help_text' => 'In \"Opportunistic Flush\" mode, caches are flushed in response to user actions; this mode is broadly compatible but may add latency during form-submissions. In \"Cron Flush\" mode, you should schedule a cron job to flush caches; this can improve latency on form-submissions but requires more setup.',
682 ],
683 'installed' => [
684 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
685 'group_name' => 'CiviCRM Preferences',
686 'group' => 'core',
687 'name' => 'installed',
688 'type' => 'Boolean',
689 'quick_form_type' => 'YesNo',
690 'default' => '',
691 'add' => '4.7',
692 'title' => 'System Installed',
693 'is_domain' => 1,
694 'is_contact' => 0,
695 'description' => 'A flag indicating whether this system has run a post-installation routine',
696 'help_text' => '',
697 ],
698 'max_attachments' => [
699 'group_name' => 'CiviCRM Preferences',
700 'group' => 'core',
701 'name' => 'max_attachments',
702 'legacy_key' => 'maxAttachments',
703 'type' => 'Integer',
704 'quick_form_type' => 'Element',
705 'html_type' => 'text',
706 'html_attributes' => [
707 'size' => 2,
708 'maxlength' => 8,
709 ],
710 'default' => 3,
711 'add' => '4.3',
712 'title' => 'Maximum Attachments',
713 'is_domain' => 1,
714 'is_contact' => 0,
715 'description' => 'Maximum number of files (documents, images, etc.) which can be attached to emails or activities.',
716 'help_text' => '',
717 ],
718 'maxFileSize' => [
719 'group_name' => 'CiviCRM Preferences',
720 'group' => 'core',
721 'name' => 'maxFileSize',
722 'type' => 'Integer',
723 'quick_form_type' => 'Element',
724 'html_type' => 'text',
725 'html_attributes' => [
726 'size' => 2,
727 'maxlength' => 8,
728 ],
729 'default' => 3,
730 'add' => '4.3',
731 'title' => 'Maximum File Size (in MB)',
732 'is_domain' => 1,
733 'is_contact' => 0,
734 'description' => 'Maximum Size of file (documents, images, etc.) which can be attached to emails or activities.<br />Note: php.ini should support this file size.',
735 'help_text' => '',
736 ],
737 'contact_undelete' => [
738 'group_name' => 'CiviCRM Preferences',
739 'group' => 'core',
740 'name' => 'contact_undelete',
741 'type' => 'Boolean',
742 'quick_form_type' => 'YesNo',
743 'default' => 1,
744 'add' => '4.3',
745 'title' => 'Contact Trash and Undelete',
746 'is_domain' => 1,
747 'is_contact' => 0,
748 '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).',
749 'help_text' => '',
750 ],
751 'allowPermDeleteFinancial' => [
752 'group_name' => 'CiviCRM Preferences',
753 'group' => 'core',
754 'name' => 'allowPermDeleteFinancial',
755 'type' => 'Boolean',
756 'quick_form_type' => 'YesNo',
757 'default' => '',
758 'add' => '4.3',
759 'title' => 'Contact Permanent Delete',
760 'is_domain' => 1,
761 'is_contact' => 0,
762 'description' => 'Allow Permanent Delete for contacts who are linked to live financial transactions',
763 'help_text' => '',
764 ],
765 'securityAlert' => [
766 'group_name' => 'CiviCRM Preferences',
767 'group' => 'core',
768 'name' => 'securityAlert',
769 'type' => 'Boolean',
770 'quick_form_type' => 'YesNo',
771 'default' => 1,
772 'add' => '4.4',
773 'title' => 'Status Alerts',
774 'is_domain' => 1,
775 'is_contact' => 0,
776 'description' => 'If enabled, CiviCRM will display pop-up notifications (no more than once per day) for security and misconfiguration issues identified in the system check.',
777 'help_text' => '',
778 ],
779 'doNotAttachPDFReceipt' => [
780 'group_name' => 'CiviCRM Preferences',
781 'group' => 'core',
782 'name' => 'doNotAttachPDFReceipt',
783 'type' => 'Boolean',
784 'quick_form_type' => 'YesNo',
785 'default' => 0,
786 'add' => '4.3',
787 'title' => 'Attach PDF copy to receipts',
788 'is_domain' => 1,
789 'is_contact' => 0,
790 'description' => 'If enabled, CiviCRM sends PDF receipt as an attachment during event signup or online contribution.',
791 'help_text' => '',
792 ],
793 'recordGeneratedLetters' => [
794 'group_name' => 'CiviCRM Preferences',
795 'group' => 'core',
796 'name' => 'recordGeneratedLetters',
797 'type' => 'String',
798 'quick_form_type' => 'Select',
799 'html_type' => 'Select',
800 'html_attributes' => [
801 'class' => 'crm-select2',
802 ],
803 'default' => 'multiple',
804 'add' => '4.7',
805 'title' => 'Record generated letters',
806 'is_domain' => 1,
807 'is_contact' => 0,
808 'description' => 'When generating a letter (PDF/Word) via mail-merge, how should the letter be recorded?',
809 'help_text' => '',
810 'pseudoconstant' => [
811 'callback' => 'CRM_Contact_Form_Task_PDFLetterCommon::getLoggingOptions',
812 ],
813 ],
814 'wkhtmltopdfPath' => [
815 'group_name' => 'CiviCRM Preferences',
816 'group' => 'core',
817 'name' => 'wkhtmltopdfPath',
818 'type' => 'String',
819 'quick_form_type' => 'Element',
820 'html_attributes' => [
821 'size' => 64,
822 'maxlength' => 256,
823 ],
824 'html_type' => 'text',
825 'default' => '',
826 'add' => '4.3',
827 'title' => 'Path to wkhtmltopdf executable',
828 'is_domain' => 1,
829 'is_contact' => 0,
830 'description' => '',
831 'help_text' => '',
832 ],
833 'recaptchaOptions' => [
834 'group_name' => 'CiviCRM Preferences',
835 'group' => 'core',
836 'name' => 'recaptchaOptions',
837 'type' => 'String',
838 'quick_form_type' => 'Element',
839 'html_attributes' => [
840 'size' => 64,
841 'maxlength' => 64,
842 ],
843 'html_type' => 'text',
844 'default' => '',
845 'add' => '4.3',
846 'title' => 'Recaptcha Options',
847 'is_domain' => 1,
848 'is_contact' => 0,
849 'description' => 'You can specify the reCAPTCHA theme options as comma separated data.(eg: theme:\'blackglass\', lang : \'fr\' ). Check the available options at <a href=\"https://developers.google.com/recaptcha/docs/display#config\">Customizing the Look and Feel of reCAPTCHA</a>.',
850 'help_text' => '',
851 ],
852 'recaptchaPublicKey' => [
853 'group_name' => 'CiviCRM Preferences',
854 'group' => 'core',
855 'name' => 'recaptchaPublicKey',
856 'type' => 'String',
857 'quick_form_type' => 'Element',
858 'html_attributes' => [
859 'size' => 64,
860 'maxlength' => 64,
861 ],
862 'html_type' => 'text',
863 'default' => '',
864 'add' => '4.3',
865 'title' => 'Recaptcha Site Key',
866 'is_domain' => 1,
867 'is_contact' => 0,
868 'description' => '',
869 'help_text' => '',
870 ],
871 'forceRecaptcha' => [
872 'add' => '4.7',
873 'help_text' => '',
874 'is_domain' => 1,
875 'is_contact' => 0,
876 'group_name' => 'CiviCRM Preferences',
877 'group' => 'core',
878 'name' => 'forceRecaptcha',
879 'type' => 'Boolean',
880 'quick_form_type' => 'YesNo',
881 'html_type' => '',
882 'default' => 0,
883 'title' => 'Force reCAPTCHA on Contribution pages',
884 'description' => 'If enabled, reCAPTCHA will show on all contribution pages.',
885 ],
886 'recaptchaPrivateKey' => [
887 'group_name' => 'CiviCRM Preferences',
888 'group' => 'core',
889 'name' => 'recaptchaPrivateKey',
890 'type' => 'String',
891 'quick_form_type' => 'Element',
892 'html_attributes' => [
893 'size' => 64,
894 'maxlength' => 64,
895 ],
896 'html_type' => 'text',
897 'default' => '',
898 'add' => '4.3',
899 'title' => 'Recaptcha Secret Key',
900 'is_domain' => 1,
901 'is_contact' => 0,
902 'description' => '',
903 'help_text' => '',
904 ],
905 'checksum_timeout' => [
906 'group_name' => 'CiviCRM Preferences',
907 'group' => 'core',
908 'name' => 'checksum_timeout',
909 'type' => 'Integer',
910 'quick_form_type' => 'Element',
911 'html_attributes' => [
912 'size' => 2,
913 'maxlength' => 8,
914 ],
915 'html_type' => 'text',
916 'default' => 7,
917 'add' => '4.3',
918 'title' => 'Checksum Lifespan',
919 'is_domain' => 1,
920 'is_contact' => 0,
921 'description' => '',
922 'help_text' => '',
923 ],
924 'blogUrl' => [
925 'group_name' => 'CiviCRM Preferences',
926 'group' => 'core',
927 'name' => 'blogUrl',
928 'type' => 'String',
929 'quick_form_type' => 'Element',
930 'html_attributes' => [
931 'size' => 64,
932 'maxlength' => 128,
933 ],
934 'html_type' => 'text',
935 'default' => '*default*',
936 'add' => '4.3',
937 'title' => 'Blog Feed URL',
938 'is_domain' => 1,
939 'is_contact' => 0,
940 'description' => 'Blog feed URL used by the blog dashlet',
941 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
942 ],
943 'communityMessagesUrl' => [
944 'group_name' => 'CiviCRM Preferences',
945 'group' => 'core',
946 'name' => 'communityMessagesUrl',
947 'type' => 'String',
948 'quick_form_type' => 'Element',
949 'html_attributes' => [
950 'size' => 64,
951 'maxlength' => 128,
952 ],
953 'html_type' => 'text',
954 'default' => '*default*',
955 'add' => '4.3',
956 'title' => 'Community Messages URL',
957 'is_domain' => 1,
958 'is_contact' => 0,
959 'description' => 'Service providing CiviCRM community messages',
960 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
961 ],
962 'gettingStartedUrl' => [
963 'group_name' => 'CiviCRM Preferences',
964 'group' => 'core',
965 'name' => 'gettingStartedUrl',
966 'type' => 'String',
967 'quick_form_type' => 'Element',
968 'html_attributes' => [
969 'size' => 64,
970 'maxlength' => 128,
971 ],
972 'html_type' => 'text',
973 'default' => '*default*',
974 'add' => '4.3',
975 'title' => 'Getting Started URL',
976 'is_domain' => 1,
977 'is_contact' => 0,
978 'description' => 'Service providing the Getting Started data',
979 'help_text' => 'Use \"*default*\" for the system default or override with a custom URL',
980 ],
981 'resCacheCode' => [
982 'group_name' => 'CiviCRM Preferences',
983 'group' => 'core',
984 'name' => 'resCacheCode',
985 'type' => 'String',
986 'quick_form_type' => 'Element',
987 'html_type' => 'text',
988 'default' => '',
989 'add' => '4.3',
990 'title' => 'resCacheCode',
991 'is_domain' => 1,
992 'is_contact' => 0,
993 'description' => 'Code appended to resource URLs (JS/CSS) to coerce HTTP caching',
994 'help_text' => '',
995 ],
996 'verifySSL' => [
997 'group_name' => 'CiviCRM Preferences',
998 'group' => 'core',
999 'name' => 'verifySSL',
1000 'type' => 'Boolean',
1001 'quick_form_type' => 'YesNo',
1002 'default' => 1,
1003 'add' => '4.3',
1004 'title' => 'Verify SSL?',
1005 'is_domain' => 1,
1006 'is_contact' => 0,
1007 'description' => 'If disabled, outbound web-service requests will allow unverified, insecure HTTPS connections',
1008 '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',
1009 ],
1010 'enableSSL' => [
1011 'group_name' => 'CiviCRM Preferences',
1012 'group' => 'core',
1013 'name' => 'enableSSL',
1014 'type' => 'Boolean',
1015 'quick_form_type' => 'YesNo',
1016 'default' => 0,
1017 'add' => '4.5',
1018 'title' => 'Force SSL?',
1019 'is_domain' => 1,
1020 'is_contact' => 0,
1021 'description' => 'If enabled, inbound HTTP requests for sensitive pages will be redirected to HTTPS.',
1022 'help_text' => 'If enabled, inbound HTTP requests for sensitive pages will be redirected to HTTPS.',
1023 ],
1024 'wpBasePage' => [
1025 'group_name' => 'CiviCRM Preferences',
1026 'group' => 'core',
1027 'name' => 'wpBasePage',
1028 'type' => 'String',
1029 'html_type' => 'text',
1030 'quick_form_type' => 'Element',
1031 'default' => '',
1032 'add' => '4.3',
1033 'title' => 'WordPress Base Page',
1034 'is_domain' => 1,
1035 'is_contact' => 0,
1036 'description' => 'If set, CiviCRM will use this setting as the base url.',
1037 '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.',
1038 ],
1039 'secondDegRelPermissions' => [
1040 'group_name' => 'CiviCRM Preferences',
1041 'group' => 'core',
1042 'name' => 'secondDegRelPermissions',
1043 'type' => 'Boolean',
1044 'quick_form_type' => 'YesNo',
1045 'default' => 0,
1046 'add' => '4.3',
1047 'title' => 'Allow second-degree relationship permissions',
1048 'is_domain' => 1,
1049 'is_contact' => 0,
1050 'description' => 'If enabled, contacts with the permission to edit a related contact will inherit that contact\'s permission to edit other related contacts',
1051 'help_text' => '',
1052 ],
1053 'enable_components' => [
1054 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1055 'group_name' => 'CiviCRM Preferences',
1056 'group' => 'core',
1057 'name' => 'enable_components',
1058 'type' => 'Array',
1059 'html_type' => 'checkboxes',
1060 'default' => '',
1061 'add' => '4.4',
1062 'title' => 'Enable Components',
1063 'is_domain' => '1',
1064 'is_contact' => 0,
1065 'description' => '',
1066 'help_text' => '',
1067 'on_change' => [
1068 '0' => 'CRM_Case_Info::onToggleComponents',
1069 '1' => 'CRM_Core_Component::flushEnabledComponents',
1070 '2' => 'call://resources/resetCacheCode',
1071 ],
1072 'pseudoconstant' => [
1073 'callback' => 'CRM_Core_SelectValues::getComponentSelectValues',
1074 ],
1075 ],
1076 'disable_core_css' => [
1077 'group_name' => 'CiviCRM Preferences',
1078 'group' => 'core',
1079 'name' => 'disable_core_css',
1080 'type' => 'Boolean',
1081 'quick_form_type' => 'YesNo',
1082 'default' => 0,
1083 'add' => '4.4',
1084 'title' => 'Disable CiviCRM css',
1085 'is_domain' => 1,
1086 'is_contact' => 0,
1087 'description' => 'Prevent the stylesheet \"civicrm.css\" from being loaded.',
1088 'help_text' => '',
1089 ],
1090 'empoweredBy' => [
1091 'group_name' => 'CiviCRM Preferences',
1092 'group' => 'core',
1093 'name' => 'empoweredBy',
1094 'type' => 'Boolean',
1095 'quick_form_type' => 'YesNo',
1096 'default' => 1,
1097 'add' => '4.5',
1098 'title' => 'Display \"empowered by CiviCRM\"',
1099 'is_domain' => 1,
1100 'is_contact' => 0,
1101 'description' => 'When enabled, \"empowered by CiviCRM\" is displayed at the bottom of public forms.',
1102 'help_text' => '',
1103 ],
1104 'logging_no_trigger_permission' => [
1105 'add' => '4.7',
1106 'is_domain' => 1,
1107 'is_contact' => 0,
1108 'group_name' => 'CiviCRM Preferences',
1109 'group' => 'core',
1110 'help_text' => '(EXPERIMENTAL) If the MySQL user does not have permission to administer triggers, then you must create the triggers outside CiviCRM. No support is provided for this configuration.',
1111 'name' => 'logging_no_trigger_permission',
1112 'type' => 'Boolean',
1113 'quick_form_type' => 'YesNo',
1114 'html_type' => '',
1115 'default' => 0,
1116 'title' => '(EXPERIMENTAL) MySQL user does not have trigger permissions',
1117 'description' => 'Set this when you intend to manage trigger creation outside of CiviCRM',
1118 ],
1119 'logging' => [
1120 'add' => '4.7',
1121 'help_text' => '',
1122 'is_domain' => 1,
1123 'is_contact' => 0,
1124 'group_name' => 'CiviCRM Preferences',
1125 'group' => 'core',
1126 'name' => 'logging',
1127 'type' => 'Boolean',
1128 'quick_form_type' => 'YesNo',
1129 'html_type' => '',
1130 'default' => 0,
1131 'title' => 'Logging',
1132 'description' => 'If enabled, all actions will be logged with a complete record of changes.',
1133 'validate_callback' => 'CRM_Logging_Schema::checkLoggingSupport',
1134 'on_change' => [
1135 '0' => 'CRM_Logging_Schema::onToggle',
1136 ],
1137 ],
1138 'logging_uniqueid_date' => [
1139 'add' => '4.7',
1140 'help_text' => 'This is the date when CRM-18193 was implemented',
1141 'is_domain' => 1,
1142 'is_contact' => 0,
1143 'group_name' => 'CiviCRM Preferences',
1144 'group' => 'core',
1145 'name' => 'logging_uniqueid_date',
1146 'type' => 'Date',
1147 'quick_form_type' => 'DateTime',
1148 'html_type' => '',
1149 'default' => '',
1150 'title' => 'Logging Unique ID not recorded before',
1151 'description' => 'This is the date when CRM-18193 was implemented',
1152 ],
1153 'logging_all_tables_uniquid' => [
1154 'add' => '4.7',
1155 'help_text' => 'This indicates there are no tables holdng pre-uniqid log_conn_id values (CRM-18193)',
1156 'is_domain' => 1,
1157 'is_contact' => 0,
1158 'group_name' => 'CiviCRM Preferences',
1159 'group' => 'core',
1160 'name' => 'logging_all_tables_uniquid',
1161 'type' => 'Boolean',
1162 'quick_form_type' => 'YesNo',
1163 'html_type' => '',
1164 'default' => 0,
1165 'title' => 'All tables use Unique Connection ID',
1166 'description' => 'Do some tables pre-date CRM-18193?',
1167 ],
1168 'userFrameworkUsersTableName' => [
1169 'add' => '4.7',
1170 'help_text' => '',
1171 'is_domain' => 1,
1172 'is_contact' => 0,
1173 'group_name' => 'CiviCRM Preferences',
1174 'group' => 'core',
1175 'name' => 'userFrameworkUsersTableName',
1176 'type' => 'String',
1177 'quick_form_type' => 'Element',
1178 'html_type' => 'text',
1179 'html_attributes' => [
1180 'size' => '32',
1181 'maxlength' => '64',
1182 ],
1183 'default' => 'users',
1184 'title' => 'CMS Users Table Name',
1185 'description' => '',
1186 ],
1187 'wpLoadPhp' => [
1188 'group_name' => 'CiviCRM Preferences',
1189 'group' => 'core',
1190 'name' => 'wpLoadPhp',
1191 'type' => 'String',
1192 'html_type' => 'text',
1193 'quick_form_type' => 'Element',
1194 'default' => '',
1195 'add' => '4.6',
1196 'title' => 'WordPress Path to wp-load.php',
1197 'is_domain' => 1,
1198 'is_contact' => 0,
1199 'description' => 'CiviCRM will use this setting as path to bootstrap WP.',
1200 'help_text' => '',
1201 ],
1202 'secure_cache_timeout_minutes' => [
1203 'group_name' => 'CiviCRM Preferences',
1204 'group' => 'core',
1205 'name' => 'secure_cache_timeout_minutes',
1206 'type' => 'Integer',
1207 'quick_form_type' => 'Element',
1208 'html_type' => 'text',
1209 'html_attributes' => [
1210 'size' => 2,
1211 'maxlength' => 8,
1212 ],
1213 'default' => 20,
1214 'add' => '4.7',
1215 'title' => 'Secure Cache Timeout',
1216 'is_domain' => 1,
1217 'is_contact' => 0,
1218 'description' => 'Maximum number of minutes that secure form data should linger',
1219 'help_text' => '',
1220 ],
1221 'site_id' => [
1222 'group_name' => 'CiviCRM Preferences',
1223 'group' => 'core',
1224 'name' => 'site_id',
1225 'type' => 'String',
1226 'quick_form_type' => 'Element',
1227 'html_type' => 'text',
1228 'default' => '',
1229 'add' => '4.6',
1230 'title' => 'Unique Site ID',
1231 'is_domain' => 1,
1232 'is_contact' => 0,
1233 'description' => '',
1234 'help_text' => '',
1235 ],
1236 'recentItemsMaxCount' => [
1237 'group_name' => 'CiviCRM Preferences',
1238 'group' => 'core',
1239 'name' => 'recentItemsMaxCount',
1240 'type' => 'Integer',
1241 'quick_form_type' => 'Element',
1242 'html_type' => 'text',
1243 'html_attributes' => [
1244 'size' => 2,
1245 'maxlength' => 3,
1246 ],
1247 'default' => 20,
1248 'add' => '4.7',
1249 'title' => 'Size of \"Recent Items\" stack',
1250 'is_domain' => 1,
1251 'is_contact' => 0,
1252 'description' => 'How many items should CiviCRM store in it\'s \"Recently viewed\" list.',
1253 'help_text' => '',
1254 ],
1255 'recentItemsProviders' => [
1256 'group_name' => 'CiviCRM Preferences',
1257 'group' => 'core',
1258 'name' => 'recentItemsProviders',
1259 'type' => 'Array',
1260 'html_type' => 'Select',
1261 'quick_form_type' => 'Select',
1262 'html_attributes' => [
1263 'multiple' => 1,
1264 'class' => 'crm-select2',
1265 ],
1266 'default' => '',
1267 'add' => '4.7',
1268 'title' => 'Recent Items Providers',
1269 'is_domain' => 1,
1270 'is_contact' => 0,
1271 'description' => 'What providers may save views in CiviCRM\'s \"Recently viewed\" list. If empty, all are in.',
1272 'help_text' => '',
1273 'pseudoconstant' => [
1274 'callback' => 'CRM_Utils_Recent::getProviders',
1275 ],
1276 ],
1277 'dedupe_default_limit' => [
1278 'group_name' => 'CiviCRM Preferences',
1279 'group' => 'core',
1280 'name' => 'dedupe_default_limit',
1281 'type' => 'Integer',
1282 'default' => 0,
1283 'quick_form_type' => 'Element',
1284 'html_type' => 'text',
1285 'add' => '4.7',
1286 'title' => 'Default limit for dedupe screen',
1287 'is_domain' => 1,
1288 'is_contact' => 0,
1289 'description' => 'Default to only loading matches against this number of contacts',
1290 'help_text' => 'Deduping larger databases can crash the server. By configuring a limit other than 0 here the dedupe query will only search for matches against a limited number of contacts.',
1291 ],
1292 'syncCMSEmail' => [
1293 'group_name' => 'CiviCRM Preferences',
1294 'group' => 'core',
1295 'name' => 'syncCMSEmail',
1296 'type' => 'Boolean',
1297 'html_type' => 'YesNo',
1298 'quick_form_type' => 'YesNo',
1299 'default' => 1,
1300 'add' => '4.7',
1301 'title' => 'Sync CMS Email',
1302 'is_domain' => 1,
1303 'is_contact' => 0,
1304 'description' => 'If enabled, then CMS email id will be synchronised with CiviCRM contacts\'s primary email.',
1305 'help_text' => '',
1306 ],
1307 'preserve_activity_tab_filter' => [
1308 'group_name' => 'CiviCRM Preferences',
1309 'group' => 'core',
1310 'name' => 'preserve_activity_tab_filter',
1311 'type' => 'Boolean',
1312 'html_type' => 'checkbox',
1313 'default' => 0,
1314 'add' => '4.7',
1315 'title' => 'Preserve activity filters as a user preference',
1316 'is_domain' => 1,
1317 'is_contact' => 0,
1318 'description' => 'When enabled, any filter settings a user selects on the contact\'s Activity tab will be remembered as they visit other contacts.',
1319 ],
1320 'do_not_notify_assignees_for' => [
1321 'group_name' => 'CiviCRM Preferences',
1322 'group' => 'core',
1323 'name' => 'do_not_notify_assignees_for',
1324 'type' => 'Array',
1325 'add' => '4.7',
1326 'is_domain' => 1,
1327 'is_contact' => 0,
1328 'default' => [],
1329 'title' => 'Do not notify assignees for',
1330 'description' => 'These activity types will be excluded from automated email notifications to assignees.',
1331 'html_type' => 'select',
1332 'html_attributes' => [
1333 'multiple' => 1,
1334 'class' => 'huge crm-select2',
1335 ],
1336 'pseudoconstant' => [
1337 'optionGroupName' => 'activity_type',
1338 ],
1339 'quick_form_type' => 'Select',
1340 ],
1341 'menubar_position' => [
1342 'group_name' => 'CiviCRM Preferences',
1343 'group' => 'core',
1344 'name' => 'menubar_position',
1345 'type' => 'String',
1346 'html_type' => 'select',
1347 'default' => 'over-cms-menu',
1348 'add' => '5.12',
1349 'title' => 'Menubar position',
1350 'is_domain' => 1,
1351 'is_contact' => 0,
1352 'description' => 'Location of the CiviCRM main menu.',
1353 'help_text' => '',
1354 'options' => [
1355 'over-cms-menu' => 'Replace website menu',
1356 'below-cms-menu' => 'Below website menu',
1357 'above-crm-container' => 'Above content area',
1358 'none' => 'None - disable menu',
1359 ],
1360 ],
1361 'menubar_color' => [
1362 'group_name' => 'CiviCRM Preferences',
1363 'group' => 'core',
1364 'name' => 'menubar_color',
1365 'type' => 'String',
1366 'html_type' => 'color',
1367 'default' => '#1b1b1b',
1368 'add' => '5.13',
1369 'title' => 'Menubar color',
1370 'is_domain' => 1,
1371 'is_contact' => 0,
1372 'description' => 'Color of the CiviCRM main menu.',
1373 'help_text' => '',
1374 'validate_callback' => 'CRM_Utils_Color::normalize',
1375 ],
1376 'requestableMimeTypes' => [
1377 'group_name' => 'CiviCRM Preferences',
1378 'group' => 'core',
1379 'name' => 'requestableMimeTypes',
1380 'type' => 'String',
1381 'html_type' => 'Text',
1382 'default' => 'image/jpeg,image/pjpeg,image/gif,image/x-png,image/png,image/jpg,text/html,application/pdf',
1383 'add' => '5.13',
1384 'title' => 'Mime Types that can be passed as URL params',
1385 'is_domain' => 1,
1386 'is_contact' => 0,
1387 'description' => 'Acceptable Mime Types that can be used as part of file urls',
1388 'help_text' => '',
1389 ],
1390 'theme_frontend' => [
1391 'group_name' => 'CiviCRM Preferences',
1392 'group' => 'core',
1393 'name' => 'theme_frontend',
1394 'type' => 'String',
1395 'quick_form_type' => 'Select',
1396 'html_type' => 'Select',
1397 'html_attributes' => [
1398 'class' => 'crm-select2',
1399 ],
1400 'pseudoconstant' => [
1401 'callback' => 'call://themes/getAvailable',
1402 ],
1403 'default' => 'default',
1404 'add' => '5.16',
1405 'title' => 'Frontend Theme',
1406 'is_domain' => 1,
1407 'is_contact' => 0,
1408 'description' => 'Theme to use on frontend pages',
1409 'help_text' => '',
1410 ],
1411 'theme_backend' => [
1412 'group_name' => 'CiviCRM Preferences',
1413 'group' => 'core',
1414 'name' => 'theme_backend',
1415 'type' => 'String',
1416 'quick_form_type' => 'Select',
1417 'html_type' => 'Select',
1418 'html_attributes' => [
1419 'class' => 'crm-select2',
1420 ],
1421 'pseudoconstant' => [
1422 'callback' => 'call://themes/getAvailable',
1423 ],
1424 'default' => 'default',
1425 'add' => '5.16',
1426 'title' => 'Backend Theme',
1427 'is_domain' => 1,
1428 'is_contact' => 0,
1429 'description' => 'Theme to use on backend pages',
1430 'help_text' => '',
1431 ],
1432 'http_timeout' => [
1433 'group_name' => 'CiviCRM Preferences',
1434 'group' => 'core',
1435 'name' => 'http_timeout',
1436 'type' => 'Integer',
1437 'quick_form_type' => 'Element',
1438 'html_type' => 'text',
1439 'html_attributes' => [
1440 'size' => 2,
1441 'maxlength' => 3,
1442 ],
1443 'default' => 5,
1444 'add' => '5.14',
1445 'title' => 'HTTP request timeout',
1446 'is_domain' => 1,
1447 'is_contact' => 0,
1448 'description' => 'How long should HTTP requests through Guzzle application run for in seconds',
1449 'help_text' => 'Set the number of seconds http requests should run for before terminating',
1450 ],
1451 'assetCache' => [
1452 'group_name' => 'Developer Preferences',
1453 'group' => 'developer',
1454 'name' => 'assetCache',
1455 'type' => 'String',
1456 'quick_form_type' => 'Select',
1457 'html_type' => 'Select',
1458 'html_attributes' => [],
1459 'default' => 'auto',
1460 'add' => '4.7',
1461 'title' => 'Asset Caching',
1462 'is_domain' => 1,
1463 'is_contact' => 0,
1464 'description' => 'Store computed JS/CSS content in cache files? (Note: In \"Auto\" mode, the \"Debug\" setting will determine whether to activate the cache.)',
1465 'help_text' => '',
1466 'pseudoconstant' => [
1467 'callback' => '\Civi\Core\AssetBuilder::getCacheModes',
1468 ],
1469 ],
1470 'userFrameworkLogging' => [
1471 'group_name' => 'Developer Preferences',
1472 'group' => 'developer',
1473 'name' => 'userFrameworkLogging',
1474 'type' => 'Boolean',
1475 'quick_form_type' => 'YesNo',
1476 'default' => 0,
1477 'add' => '4.3',
1478 'title' => 'Enable Drupal Watchdog Logging',
1479 'is_domain' => 1,
1480 'is_contact' => 0,
1481 'description' => 'Set this value to Yes if you want CiviCRM error/debugging messages to appear in the Drupal error logs',
1482 '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)',
1483 ],
1484 'debug_enabled' => [
1485 'group_name' => 'Developer Preferences',
1486 'group' => 'developer',
1487 'name' => 'debug_enabled',
1488 'config_key' => 'debug',
1489 'type' => 'Boolean',
1490 'quick_form_type' => 'YesNo',
1491 'default' => 0,
1492 'add' => '4.3',
1493 'title' => 'Enable Debugging',
1494 'is_domain' => 1,
1495 'is_contact' => 0,
1496 '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',
1497 'help_text' => 'Do not turn this on on production sites',
1498 ],
1499 'backtrace' => [
1500 'group_name' => 'Developer Preferences',
1501 'group' => 'developer',
1502 'name' => 'backtrace',
1503 'type' => 'Boolean',
1504 'quick_form_type' => 'YesNo',
1505 'default' => 0,
1506 'add' => '4.3',
1507 'title' => 'Display Backtrace',
1508 'is_domain' => 1,
1509 'is_contact' => 0,
1510 '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',
1511 ],
1512 'environment' => [
1513 'group_name' => 'Developer Preferences',
1514 'group' => 'developer',
1515 'name' => 'environment',
1516 'type' => 'String',
1517 'html_type' => 'Select',
1518 'quick_form_type' => 'Select',
1519 'default' => 'Production',
1520 'pseudoconstant' => [
1521 'optionGroupName' => 'environment',
1522 ],
1523 'add' => '4.7',
1524 'title' => 'Environment',
1525 'is_domain' => 1,
1526 'is_contact' => 0,
1527 'description' => 'Setting to define the environment in which this CiviCRM instance is running.',
1528 'on_change' => [
1529 '0' => 'CRM_Core_BAO_Setting::onChangeEnvironmentSetting',
1530 ],
1531 ],
1532 'fatalErrorHandler' => [
1533 'group_name' => 'Developer Preferences',
1534 'group' => 'developer',
1535 'name' => 'fatalErrorHandler',
1536 'type' => 'String',
1537 'quick_form_type' => 'Element',
1538 'html_type' => 'text',
1539 'default' => '',
1540 'add' => '4.3',
1541 'title' => 'Fatal Error Handler',
1542 'is_domain' => 1,
1543 'is_contact' => 0,
1544 '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.',
1545 ],
1546 'uploadDir' => [
1547 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1548 'group_name' => 'Directory Preferences',
1549 'group' => 'directory',
1550 'name' => 'uploadDir',
1551 'type' => 'String',
1552 'html_type' => 'text',
1553 'quick_form_type' => 'Element',
1554 'default' => '',
1555 'add' => '4.1',
1556 'title' => 'Temporary Files Directory',
1557 'is_domain' => 1,
1558 'is_contact' => 0,
1559 'description' => '',
1560 'help_text' => 'File system path where temporary CiviCRM files - such as import data files - are uploaded.',
1561 ],
1562 'imageUploadDir' => [
1563 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1564 'group_name' => 'Directory Preferences',
1565 'group' => 'directory',
1566 'name' => 'imageUploadDir',
1567 'type' => 'String',
1568 'html_type' => 'text',
1569 'quick_form_type' => 'Element',
1570 'default' => '',
1571 'add' => '4.1',
1572 'title' => 'Image Directory',
1573 'is_domain' => 1,
1574 'is_contact' => 0,
1575 'description' => 'File system path where image files are uploaded. Currently, this path is used for images associated with premiums (CiviContribute thank-you gifts).',
1576 'help_text' => '',
1577 ],
1578 'customFileUploadDir' => [
1579 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1580 'group_name' => 'Directory Preferences',
1581 'group' => 'directory',
1582 'name' => 'customFileUploadDir',
1583 'type' => 'String',
1584 'html_type' => 'text',
1585 'quick_form_type' => 'Element',
1586 'default' => '',
1587 'add' => '4.1',
1588 'title' => 'Custom Files Directory',
1589 'is_domain' => 1,
1590 'is_contact' => 0,
1591 'description' => 'Path where documents and images which are attachments to contact records are stored (e.g. contact photos, resumes, contracts, etc.). These attachments are defined using \'file\' type custom fields.',
1592 'help_text' => '',
1593 ],
1594 'customTemplateDir' => [
1595 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1596 'group_name' => 'Directory Preferences',
1597 'group' => 'directory',
1598 'name' => 'customTemplateDir',
1599 'type' => 'String',
1600 'html_type' => 'text',
1601 'quick_form_type' => 'Element',
1602 'default' => '',
1603 'add' => '4.1',
1604 'title' => 'Custom Template Directory',
1605 'is_domain' => 1,
1606 'is_contact' => 0,
1607 'description' => 'Path where site specific templates are stored if any. This directory is searched first if set. Custom JavaScript code can be added to templates by creating files named templateFile.extra.tpl. (learn more...)',
1608 'help_text' => '',
1609 ],
1610 'customPHPPathDir' => [
1611 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1612 'group_name' => 'Directory Preferences',
1613 'group' => 'directory',
1614 'name' => 'customPHPPathDir',
1615 'type' => 'String',
1616 'html_type' => 'text',
1617 'quick_form_type' => 'Element',
1618 'default' => '',
1619 'add' => '4.1',
1620 'title' => 'Custom PHP Directory',
1621 'is_domain' => 1,
1622 'is_contact' => 0,
1623 'description' => 'Path where site specific PHP code files are stored if any. This directory is searched first if set.',
1624 'help_text' => '',
1625 ],
1626 'extensionsDir' => [
1627 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
1628 'group_name' => 'Directory Preferences',
1629 'group' => 'directory',
1630 'name' => 'extensionsDir',
1631 'type' => 'String',
1632 'html_type' => 'text',
1633 'quick_form_type' => 'Element',
1634 'default' => '',
1635 'add' => '4.1',
1636 'title' => 'Extensions Directory',
1637 'is_domain' => 1,
1638 'is_contact' => 0,
1639 'description' => 'Path where CiviCRM extensions are stored.',
1640 'help_text' => '',
1641 ],
1642 'enable_cart' => [
1643 'name' => 'enable_cart',
1644 'group_name' => 'Event Preferences',
1645 'settings_pages' => [
1646 'event' => [
1647 'weight' => 10,
1648 ],
1649 ],
1650 'group' => 'event',
1651 'type' => 'Boolean',
1652 'quick_form_type' => 'CheckBox',
1653 'default' => 0,
1654 'add' => '4.1',
1655 'title' => 'Use Shopping Cart Style Event Registration',
1656 'is_domain' => 1,
1657 'is_contact' => 0,
1658 'description' => 'This feature allows users to register for more than one event at a time. When enabled, users will add event(s) to a \"cart\" and then pay for them all at once. Enabling this setting will affect online registration for all active events. The code is an alpha state, and you will potentially need to have developer resources to debug and fix sections of the codebase while testing and deploying it',
1659 'help_text' => '',
1660 'documentation_link' => [
1661 'page' => 'CiviEvent Cart Checkout',
1662 'resource' => 'wiki',
1663 ],
1664 ],
1665 'show_events' => [
1666 'name' => 'show_events',
1667 'group_name' => 'Event Preferences',
1668 'group' => 'event',
1669 'settings_pages' => [
1670 'event' => [
1671 'weight' => 20,
1672 ],
1673 ],
1674 'type' => 'Integer',
1675 'quick_form_type' => 'Select',
1676 'default' => 10,
1677 'add' => '4.5',
1678 'title' => 'Dashboard entries',
1679 'html_type' => 'select',
1680 'is_domain' => 1,
1681 'is_contact' => 0,
1682 'description' => 'Configure how many events should be shown on the dashboard. This overrides the default value of 10 entries.',
1683 'help_text' => '',
1684 'pseudoconstant' => [
1685 'callback' => 'CRM_Core_SelectValues::getDashboardEntriesCount',
1686 ],
1687 ],
1688 'ext_repo_url' => [
1689 'group_name' => 'Extension Preferences',
1690 'group' => 'ext',
1691 'name' => 'ext_repo_url',
1692 'type' => 'String',
1693 'quick_form_type' => 'Element',
1694 'html_attributes' => [
1695 'size' => 64,
1696 'maxlength' => 128,
1697 ],
1698 'html_type' => 'text',
1699 'default' => 'https://civicrm.org/extdir/ver={ver}|cms={uf}',
1700 'add' => '4.3',
1701 'title' => 'Extension Repo URL',
1702 'is_domain' => 1,
1703 'is_contact' => 0,
1704 'description' => '',
1705 'help_text' => '',
1706 ],
1707 'customTranslateFunction' => [
1708 'add' => '4.7',
1709 'help_text' => '',
1710 'is_domain' => 1,
1711 'is_contact' => 0,
1712 'group_name' => 'Localization Preferences',
1713 'group' => 'localization',
1714 'name' => 'customTranslateFunction',
1715 'type' => 'String',
1716 'quick_form_type' => 'Element',
1717 'html_type' => 'text',
1718 'html_attributes' => [
1719 'size' => '30',
1720 'maxlength' => '100',
1721 ],
1722 'default' => '',
1723 'title' => 'Custom Translate Function',
1724 'description' => '',
1725 ],
1726 'monetaryThousandSeparator' => [
1727 'group_name' => 'Localization Preferences',
1728 'group' => 'localization',
1729 'name' => 'monetaryThousandSeparator',
1730 'type' => 'String',
1731 'quick_form_type' => 'Element',
1732 'html_type' => 'text',
1733 'html_attributes' => [
1734 'size' => 2,
1735 ],
1736 'default' => ',',
1737 'add' => '4.3',
1738 'title' => 'Thousands Separator',
1739 'is_domain' => 1,
1740 'is_contact' => 0,
1741 'description' => '',
1742 'help_text' => '',
1743 ],
1744 'monetaryDecimalPoint' => [
1745 'group_name' => 'Localization Preferences',
1746 'group' => 'localization',
1747 'name' => 'monetaryDecimalPoint',
1748 'type' => 'String',
1749 'quick_form_type' => 'Element',
1750 'html_type' => 'text',
1751 'html_attributes' => [
1752 'size' => 2,
1753 ],
1754 'default' => '.',
1755 'add' => '4.3',
1756 'title' => 'Decimal Delimiter',
1757 'is_domain' => 1,
1758 'is_contact' => 0,
1759 'description' => '',
1760 'help_text' => '',
1761 ],
1762 'moneyformat' => [
1763 'group_name' => 'Localization Preferences',
1764 'group' => 'localization',
1765 'name' => 'moneyformat',
1766 'type' => 'String',
1767 'quick_form_type' => 'Element',
1768 'html_type' => 'text',
1769 'default' => '%c %a',
1770 'add' => '4.3',
1771 'title' => 'Monetary Amount Display',
1772 'is_domain' => 1,
1773 'is_contact' => 0,
1774 'description' => '',
1775 'help_text' => '',
1776 ],
1777 'moneyvalueformat' => [
1778 'group_name' => 'Localization Preferences',
1779 'group' => 'localization',
1780 'name' => 'moneyvalueformat',
1781 'type' => 'String',
1782 'quick_form_type' => 'Element',
1783 'html_type' => 'text',
1784 'default' => '%!i',
1785 'add' => '4.3',
1786 'title' => 'Monetary Value Display',
1787 'is_domain' => 1,
1788 'is_contact' => 0,
1789 'description' => '',
1790 'help_text' => '',
1791 ],
1792 'defaultCurrency' => [
1793 'group_name' => 'Localization Preferences',
1794 'group' => 'localization',
1795 'name' => 'defaultCurrency',
1796 'type' => 'String',
1797 'quick_form_type' => 'Select',
1798 'html_type' => 'Select',
1799 'html_attributes' => [
1800 'class' => 'crm-select2',
1801 ],
1802 'default' => 'USD',
1803 'add' => '4.3',
1804 'title' => 'Default Currency',
1805 'is_domain' => 1,
1806 'is_contact' => 0,
1807 'description' => 'Default currency assigned to contributions and other monetary transactions.',
1808 'help_text' => '',
1809 'pseudoconstant' => [
1810 'callback' => 'CRM_Admin_Form_Setting_Localization::getCurrencySymbols',
1811 ],
1812 'on_change' => [
1813 '0' => 'CRM_Admin_Form_Setting_Localization::onChangeDefaultCurrency',
1814 ],
1815 ],
1816 'defaultContactCountry' => [
1817 'group_name' => 'Localization Preferences',
1818 'group' => 'localization',
1819 'name' => 'defaultContactCountry',
1820 'type' => 'String',
1821 'quick_form_type' => 'Select',
1822 'html_type' => 'Select',
1823 'html_attributes' => [],
1824 'add' => '4.4',
1825 'title' => 'Default Country',
1826 'is_domain' => 1,
1827 'is_contact' => 0,
1828 'is_required' => '',
1829 'description' => 'This value is selected by default when adding a new contact address.',
1830 'help_text' => '',
1831 'pseudoconstant' => [
1832 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
1833 ],
1834 ],
1835 'defaultContactStateProvince' => [
1836 'add' => '4.7',
1837 'help_text' => '',
1838 'is_domain' => 1,
1839 'is_contact' => 0,
1840 'group_name' => 'Localization Preferences',
1841 'group' => 'localization',
1842 'name' => 'defaultContactStateProvince',
1843 'type' => 'Integer',
1844 'quick_form_type' => 'ChainSelect',
1845 'html_type' => 'ChainSelect',
1846 'default' => '',
1847 'title' => 'Default State/Province',
1848 'description' => 'This value is selected by default when adding a new contact address.',
1849 ],
1850 'countryLimit' => [
1851 'group_name' => 'Localization Preferences',
1852 'group' => 'localization',
1853 'name' => 'countryLimit',
1854 'type' => 'Array',
1855 'quick_form_type' => 'Element',
1856 'html_type' => 'advmultiselect',
1857 'html_attributes' => [
1858 'size' => 5,
1859 'style' => 'width:150px',
1860 'class' => 'advmultiselect',
1861 ],
1862 'default' => [],
1863 'add' => '4.3',
1864 'title' => 'Available Countries',
1865 'is_domain' => 1,
1866 'is_contact' => 0,
1867 'description' => '',
1868 'help_text' => '',
1869 'pseudoconstant' => [
1870 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
1871 ],
1872 ],
1873 'provinceLimit' => [
1874 'group_name' => 'Localization Preferences',
1875 'group' => 'localization',
1876 'name' => 'provinceLimit',
1877 'type' => 'Array',
1878 'quick_form_type' => 'Element',
1879 'html_type' => 'advmultiselect',
1880 'html_attributes' => [
1881 'size' => 5,
1882 'style' => 'width:150px',
1883 'class' => 'advmultiselect',
1884 ],
1885 'default' => [],
1886 'add' => '4.3',
1887 'title' => 'Available States and Provinces (by Country)',
1888 'is_domain' => 1,
1889 'is_contact' => 0,
1890 'description' => '',
1891 'help_text' => '',
1892 'pseudoconstant' => [
1893 'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
1894 ],
1895 ],
1896 'inheritLocale' => [
1897 'group_name' => 'Localization Preferences',
1898 'group' => 'localization',
1899 'name' => 'inheritLocale',
1900 'type' => 'Boolean',
1901 'quick_form_type' => 'YesNo',
1902 'default' => 0,
1903 'add' => '4.3',
1904 'title' => 'Inherit CMS Language',
1905 'is_domain' => 1,
1906 'is_contact' => 0,
1907 'description' => '',
1908 'help_text' => '',
1909 ],
1910 'dateformatDatetime' => [
1911 'group_name' => 'Localization Preferences',
1912 'group' => 'localization',
1913 'name' => 'dateformatDatetime',
1914 'type' => 'String',
1915 'quick_form_type' => 'Element',
1916 'html_type' => 'text',
1917 'default' => '%B %E%f, %Y %l:%M %P',
1918 'add' => '4.3',
1919 'title' => 'Date Format: Complete Date and Time',
1920 'is_domain' => 1,
1921 'is_contact' => 0,
1922 'description' => '',
1923 'help_text' => '',
1924 ],
1925 'dateformatFull' => [
1926 'group_name' => 'Localization Preferences',
1927 'group' => 'localization',
1928 'name' => 'dateformatFull',
1929 'type' => 'String',
1930 'quick_form_type' => 'Element',
1931 'html_type' => 'text',
1932 'default' => '%B %E%f, %Y',
1933 'add' => '4.3',
1934 'title' => 'Date Format: Complete Date',
1935 'is_domain' => 1,
1936 'is_contact' => 0,
1937 'description' => '',
1938 'help_text' => '',
1939 ],
1940 'dateformatPartial' => [
1941 'group_name' => 'Localization Preferences',
1942 'group' => 'localization',
1943 'name' => 'dateformatPartial',
1944 'type' => 'String',
1945 'quick_form_type' => 'Element',
1946 'html_type' => 'text',
1947 'default' => '%B %Y',
1948 'add' => '4.3',
1949 'title' => 'Date Format: Month and Year',
1950 'is_domain' => 1,
1951 'is_contact' => 0,
1952 'description' => '',
1953 'help_text' => '',
1954 ],
1955 'dateformatTime' => [
1956 'add' => '4.7',
1957 'help_text' => '',
1958 'is_domain' => 1,
1959 'is_contact' => 0,
1960 'group_name' => 'Localization Preferences',
1961 'group' => 'localization',
1962 'name' => 'dateformatTime',
1963 'type' => 'String',
1964 'quick_form_type' => 'Element',
1965 'html_type' => 'text',
1966 'html_attributes' => [
1967 'size' => '12',
1968 'maxlength' => '60',
1969 ],
1970 'default' => '%l:%M %P',
1971 'title' => 'Date Format: Time Only',
1972 'description' => '',
1973 ],
1974 'dateformatYear' => [
1975 'add' => '4.7',
1976 'help_text' => '',
1977 'is_domain' => 1,
1978 'is_contact' => 0,
1979 'group_name' => 'Localization Preferences',
1980 'group' => 'localization',
1981 'name' => 'dateformatYear',
1982 'type' => 'String',
1983 'quick_form_type' => 'Element',
1984 'html_type' => 'text',
1985 'html_attributes' => [
1986 'size' => '12',
1987 'maxlength' => '60',
1988 ],
1989 'default' => '%Y',
1990 'title' => 'Date Format: Year Only',
1991 'description' => '',
1992 ],
1993 'dateformatFinancialBatch' => [
1994 'add' => '4.7',
1995 'help_text' => '',
1996 'is_domain' => 1,
1997 'is_contact' => 0,
1998 'group_name' => 'Localization Preferences',
1999 'group' => 'localization',
2000 'name' => 'dateformatFinancialBatch',
2001 'type' => 'String',
2002 'quick_form_type' => 'Element',
2003 'html_type' => 'text',
2004 'html_attributes' => [
2005 'size' => '12',
2006 'maxlength' => '60',
2007 ],
2008 'default' => '%m/%d/%Y',
2009 'title' => 'Date Format: Financial Batch',
2010 'description' => '',
2011 ],
2012 'dateformatshortdate' => [
2013 'add' => '4.7',
2014 'help_text' => '',
2015 'is_domain' => 1,
2016 'is_contact' => 0,
2017 'group_name' => 'Localization Preferences',
2018 'group' => 'localization',
2019 'name' => 'dateformatshortdate',
2020 'type' => 'String',
2021 'quick_form_type' => 'Element',
2022 'html_type' => 'text',
2023 'html_attributes' => [
2024 'size' => '12',
2025 'maxlength' => '60',
2026 ],
2027 'default' => '%m/%d/%Y',
2028 'title' => 'Date Format: Short date Month Day Year',
2029 'description' => '',
2030 ],
2031 'dateInputFormat' => [
2032 'add' => '4.7',
2033 'help_text' => '',
2034 'is_domain' => 1,
2035 'is_contact' => 0,
2036 'group_name' => 'Localization Preferences',
2037 'group' => 'localization',
2038 'name' => 'dateInputFormat',
2039 'type' => 'String',
2040 'quick_form_type' => 'Select',
2041 'html_type' => 'Select',
2042 'pseudoconstant' => [
2043 'callback' => 'CRM_Core_SelectValues::getDatePluginInputFormats',
2044 ],
2045 'default' => 'mm/dd/yy',
2046 'title' => 'Date Input Format',
2047 'description' => '',
2048 ],
2049 'fieldSeparator' => [
2050 'add' => '4.7',
2051 'help_text' => '',
2052 'is_domain' => 1,
2053 'is_contact' => 0,
2054 'group_name' => 'Localization Preferences',
2055 'group' => 'localization',
2056 'name' => 'fieldSeparator',
2057 'type' => 'String',
2058 'quick_form_type' => 'Element',
2059 'html_type' => 'text',
2060 'html_attributes' => [
2061 'size' => '2',
2062 'maxlength' => '8',
2063 ],
2064 'default' => ',',
2065 'title' => 'Import / Export Field Separator',
2066 'description' => 'Global CSV separator character. Modify this setting to enable import and export of different kinds of CSV files (for example: \',\' \';\' \':\' \'|\' ).',
2067 ],
2068 'fiscalYearStart' => [
2069 'add' => '4.7',
2070 'help_text' => '',
2071 'is_domain' => 1,
2072 'is_contact' => 0,
2073 'group_name' => 'Localization Preferences',
2074 'group' => 'localization',
2075 'name' => 'fiscalYearStart',
2076 'type' => 'Array',
2077 'quick_form_type' => 'MonthDay',
2078 'html_type' => 'MonthDay',
2079 'default' => [
2080 'M' => 1,
2081 'd' => 1,
2082 ],
2083 'title' => 'Fiscal Year Start',
2084 'description' => '',
2085 ],
2086 'languageLimit' => [
2087 'group_name' => 'Localization Preferences',
2088 'group' => 'localization',
2089 'name' => 'languageLimit',
2090 'type' => 'Array',
2091 'quick_form_type' => 'Select',
2092 'html_type' => 'Select',
2093 'html_attributes' => [
2094 'multiple' => 1,
2095 'class' => 'crm-select2',
2096 ],
2097 'default' => '',
2098 'add' => '4.3',
2099 'title' => 'Available Languages (Multi-lingual)',
2100 'is_domain' => 1,
2101 'is_contact' => 0,
2102 'description' => '',
2103 'help_text' => '',
2104 'pseudoconstant' => [
2105 'callback' => 'CRM_Core_I18n::languages',
2106 ],
2107 ],
2108 'uiLanguages' => [
2109 'group_name' => 'Localization Preferences',
2110 'group' => 'localization',
2111 'name' => 'uiLanguages',
2112 'type' => 'Array',
2113 'quick_form_type' => 'Select',
2114 'html_type' => 'select',
2115 'html_attributes' => [
2116 'multiple' => 1,
2117 'class' => 'crm-select2',
2118 ],
2119 'default' => '',
2120 'add' => '5.9',
2121 'title' => 'Available Languages',
2122 'is_domain' => 1,
2123 'is_contact' => 0,
2124 'description' => '',
2125 'help_text' => 'User Interface languages available to users',
2126 'pseudoconstant' => [
2127 'callback' => 'CRM_Core_I18n::languages',
2128 ],
2129 ],
2130 'lcMessages' => [
2131 'group_name' => 'Localization Preferences',
2132 'group' => 'localization',
2133 'name' => 'lcMessages',
2134 'type' => 'String',
2135 'quick_form_type' => 'Select',
2136 'html_type' => 'Select',
2137 'html_attributes' => [
2138 'class' => 'crm-select2',
2139 ],
2140 'default' => 'en_US',
2141 'add' => '4.3',
2142 'title' => 'Default Language',
2143 'is_domain' => 1,
2144 'is_contact' => 0,
2145 'description' => '',
2146 'help_text' => '',
2147 'pseudoconstant' => [
2148 'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLocaleOptions',
2149 ],
2150 'on_change' => [
2151 '0' => 'CRM_Admin_Form_Setting_Localization::onChangeLcMessages',
2152 ],
2153 ],
2154 'legacyEncoding' => [
2155 'add' => '4.7',
2156 'help_text' => '',
2157 'is_domain' => 1,
2158 'is_contact' => 0,
2159 'group_name' => 'Localization Preferences',
2160 'group' => 'localization',
2161 'name' => 'legacyEncoding',
2162 'type' => 'String',
2163 'quick_form_type' => 'Element',
2164 'html_type' => 'text',
2165 'html_attributes' => [
2166 'size' => '12',
2167 'maxlength' => '30',
2168 ],
2169 'default' => 'Windows-1252',
2170 'title' => 'Legacy Encoding',
2171 'description' => 'If import files are NOT encoded as UTF-8, specify an alternate character encoding for these files. The default of Windows-1252 will work for Excel-created .CSV files on many computers.',
2172 ],
2173 'timeInputFormat' => [
2174 'add' => '4.7',
2175 'help_text' => '',
2176 'is_domain' => 1,
2177 'is_contact' => 0,
2178 'group_name' => 'Localization Preferences',
2179 'group' => 'localization',
2180 'name' => 'timeInputFormat',
2181 'type' => 'String',
2182 'quick_form_type' => 'Select',
2183 'html_type' => 'Select',
2184 'pseudoconstant' => [
2185 'callback' => 'CRM_Core_SelectValues::getTimeFormats',
2186 ],
2187 'default' => '1',
2188 'title' => 'Time Input Format',
2189 'description' => '',
2190 'on_change' => [
2191 '0' => 'CRM_Core_BAO_PreferencesDate::onChangeSetting',
2192 ],
2193 ],
2194 'weekBegins' => [
2195 'group_name' => 'Localization Preferences',
2196 'group' => 'localization',
2197 'name' => 'weekBegins',
2198 'type' => 'String',
2199 'quick_form_type' => 'Select',
2200 'html_type' => 'Select',
2201 'pseudoconstant' => [
2202 'callback' => 'CRM_Utils_Date::getFullWeekdayNames',
2203 ],
2204 'default' => 0,
2205 'add' => '4.7',
2206 'title' => 'Week begins on',
2207 'is_domain' => 1,
2208 'is_contact' => 0,
2209 'description' => '',
2210 'help_text' => '',
2211 ],
2212 'contact_default_language' => [
2213 'group_name' => 'Localization Preferences',
2214 'group' => 'localization',
2215 'name' => 'contact_default_language',
2216 'type' => 'String',
2217 'quick_form_type' => 'Select',
2218 'html_type' => 'Select',
2219 'html_attributes' => [
2220 'class' => 'crm-select2',
2221 ],
2222 'pseudoconstant' => [
2223 'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLanguageOptions',
2224 ],
2225 'default' => '*default*',
2226 'add' => '4.7',
2227 'title' => 'Default Language for contacts',
2228 'is_domain' => 1,
2229 'is_contact' => 0,
2230 'description' => 'Default language (if any) for contact records',
2231 'help_text' => 'If a contact is created with no language this setting will determine the language data (if any) to save.You may or may not wish to make an assumption here about whether it matches the site language',
2232 ],
2233 'profile_double_optin' => [
2234 'group_name' => 'Mailing Preferences',
2235 'group' => 'mailing',
2236 'name' => 'profile_double_optin',
2237 'type' => 'Boolean',
2238 'html_type' => 'checkbox',
2239 'default' => '1',
2240 'add' => '4.1',
2241 'title' => 'Enable Double Opt-in for Profile Group(s) field',
2242 'is_domain' => 1,
2243 'is_contact' => 0,
2244 '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.',
2245 'help_text' => '',
2246 ],
2247 'track_civimail_replies' => [
2248 'group_name' => 'Mailing Preferences',
2249 'group' => 'mailing',
2250 'name' => 'track_civimail_replies',
2251 'type' => 'Boolean',
2252 'html_type' => 'checkbox',
2253 'default' => 0,
2254 'add' => '4.1',
2255 'title' => 'Track replies using VERP in Reply-To header',
2256 'is_domain' => 1,
2257 'is_contact' => 0,
2258 'description' => 'If checked, mailings will default to tracking replies using VERP-ed Reply-To. ',
2259 'help_text' => '',
2260 'validate_callback' => 'CRM_Core_BAO_Setting::validateBoolSetting',
2261 ],
2262 'civimail_workflow' => [
2263 'group_name' => 'Mailing Preferences',
2264 'group' => 'mailing',
2265 'name' => 'civimail_workflow',
2266 'type' => 'Boolean',
2267 'html_type' => 'checkbox',
2268 'default' => 0,
2269 'add' => '4.1',
2270 'title' => 'Enable workflow support for CiviMail',
2271 'is_domain' => 1,
2272 'is_contact' => 0,
2273 'description' => 'Drupal-only. Rules module must be enabled (beta feature - use with caution).',
2274 'help_text' => '',
2275 ],
2276 'civimail_server_wide_lock' => [
2277 'group_name' => 'Mailing Preferences',
2278 'group' => 'mailing',
2279 'name' => 'civimail_server_wide_lock',
2280 'type' => 'Boolean',
2281 'html_type' => 'checkbox',
2282 'default' => 0,
2283 'add' => '4.1',
2284 'title' => 'Enable global server wide lock for CiviMail',
2285 'is_domain' => 1,
2286 'is_contact' => 0,
2287 'description' => '',
2288 'help_text' => '',
2289 ],
2290 'replyTo' => [
2291 'group_name' => 'Mailing Preferences',
2292 'group' => 'mailing',
2293 'name' => 'replyTo',
2294 'type' => 'Boolean',
2295 'quick_form_type' => 'YesNo',
2296 'default' => 0,
2297 'add' => '4.6',
2298 'title' => 'Enable Custom Reply-To',
2299 'is_domain' => 1,
2300 'is_contact' => 0,
2301 'description' => 'Allow CiviMail users to send mailings with a custom Reply-To header',
2302 'help_text' => '',
2303 ],
2304 'mailing_backend' => [
2305 'group_name' => 'Mailing Preferences',
2306 'group' => 'mailing',
2307 'name' => 'mailing_backend',
2308 'type' => 'Array',
2309 'html_type' => 'checkbox',
2310 'default' => [
2311 'outBound_option' => '3',
2312 ],
2313 'add' => '4.1',
2314 'title' => 'Mailing Backend',
2315 'is_domain' => 1,
2316 'is_contact' => 0,
2317 'description' => '',
2318 'help_text' => '',
2319 ],
2320 'profile_add_to_group_double_optin' => [
2321 'group_name' => 'Mailing Preferences',
2322 'group' => 'mailing',
2323 'name' => 'profile_add_to_group_double_optin',
2324 'type' => 'Boolean',
2325 'html_type' => 'checkbox',
2326 'default' => 0,
2327 'add' => '4.1',
2328 'title' => 'Enable Double Opt-in for Profiles which use the \"Add to Group\" setting',
2329 'is_domain' => 1,
2330 'is_contact' => 0,
2331 'description' => 'When CiviMail is enabled and a profile uses the \"Add to Group\" setting, users who complete the profile form will receive a confirmation email. They must respond (opt-in) before they are added to the group.',
2332 'help_text' => '',
2333 ],
2334 'disable_mandatory_tokens_check' => [
2335 'group_name' => 'Mailing Preferences',
2336 'group' => 'mailing',
2337 'name' => 'disable_mandatory_tokens_check',
2338 'type' => 'Boolean',
2339 'html_type' => 'checkbox',
2340 'default' => 0,
2341 'add' => '4.4',
2342 'title' => 'Disable check for mandatory tokens',
2343 'is_domain' => 1,
2344 'is_contact' => 0,
2345 '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.',
2346 'help_text' => '',
2347 ],
2348 'dedupe_email_default' => [
2349 'group_name' => 'Mailing Preferences',
2350 'group' => 'mailing',
2351 'name' => 'dedupe_email_default',
2352 'type' => 'Boolean',
2353 'html_type' => 'checkbox',
2354 'default' => 1,
2355 'add' => '4.5',
2356 'title' => 'CiviMail dedupes e-mail addresses by default',
2357 'is_domain' => 1,
2358 'is_contact' => 0,
2359 'description' => 'Set the \"dedupe e-mail\" option when sending a new mailing to \"true\" by default.',
2360 'help_text' => '',
2361 ],
2362 'hash_mailing_url' => [
2363 'group_name' => 'Mailing Preferences',
2364 'group' => 'mailing',
2365 'name' => 'hash_mailing_url',
2366 'type' => 'Boolean',
2367 'html_type' => 'checkbox',
2368 'default' => 0,
2369 'add' => '4.5',
2370 'title' => 'Hashed Mailing URL\'s',
2371 'is_domain' => 1,
2372 'is_contact' => 0,
2373 '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',
2374 'help_text' => '',
2375 ],
2376 'civimail_multiple_bulk_emails' => [
2377 'group_name' => 'Mailing Preferences',
2378 'group' => 'mailing',
2379 'name' => 'civimail_multiple_bulk_emails',
2380 'type' => 'Boolean',
2381 'html_type' => 'checkbox',
2382 'default' => 0,
2383 'add' => '4.5',
2384 'title' => 'Enable multiple bulk email address for a contact.',
2385 'is_domain' => 1,
2386 'is_contact' => 0,
2387 'description' => 'CiviMail will deliver a copy of the email to each bulk email listed for the contact. Enabling this setting will also change the options for the \"Email on Hold\" field in Advanced Search.',
2388 'help_text' => '',
2389 ],
2390 'include_message_id' => [
2391 'group_name' => 'Mailing Preferences',
2392 'group' => 'mailing',
2393 'name' => 'include_message_id',
2394 'type' => 'Boolean',
2395 'html_type' => 'checkbox',
2396 'default' => '',
2397 'add' => '4.5',
2398 'title' => 'Enable CiviMail to generate Message-ID header',
2399 'is_domain' => 1,
2400 'is_contact' => 0,
2401 'description' => '',
2402 'help_text' => '',
2403 ],
2404 'mailerBatchLimit' => [
2405 'group_name' => 'Mailing Preferences',
2406 'group' => 'mailing',
2407 'name' => 'mailerBatchLimit',
2408 'type' => 'Integer',
2409 'quick_form_type' => 'Element',
2410 'html_type' => 'text',
2411 'html_attributes' => [
2412 'size' => 4,
2413 'maxlength' => 8,
2414 ],
2415 'default' => 0,
2416 'add' => '4.7',
2417 'title' => 'Mailer Batch Limit',
2418 'is_domain' => 1,
2419 'is_contact' => 0,
2420 'description' => 'Throttle email delivery by setting the maximum number of emails sent during each CiviMail run (0 = unlimited).',
2421 'help_text' => '',
2422 ],
2423 'mailerJobSize' => [
2424 'group_name' => 'Mailing Preferences',
2425 'group' => 'mailing',
2426 'name' => 'mailerJobSize',
2427 'type' => 'Integer',
2428 'quick_form_type' => 'Element',
2429 'html_type' => 'text',
2430 'html_attributes' => [
2431 'size' => 4,
2432 'maxlength' => 8,
2433 ],
2434 'default' => 0,
2435 'add' => '4.7',
2436 'title' => 'Mailer Job Size',
2437 'is_domain' => 1,
2438 'is_contact' => 0,
2439 'description' => 'If you want to utilize multi-threading enter the size you want your sub jobs to be split into. Recommended values are between 1,000 and 10,000. Use a lower value if your server has multiple cron jobs running simultaneously, but do not use values smaller than 1,000. Enter \"0\" to disable multi-threading and process mail as one single job - batch limits still apply.',
2440 'help_text' => '',
2441 ],
2442 'mailerJobsMax' => [
2443 'group_name' => 'Mailing Preferences',
2444 'group' => 'mailing',
2445 'name' => 'mailerJobsMax',
2446 'type' => 'Integer',
2447 'quick_form_type' => 'Element',
2448 'html_type' => 'text',
2449 'html_attributes' => [
2450 'size' => 4,
2451 'maxlength' => 8,
2452 ],
2453 'default' => 0,
2454 'add' => '4.7',
2455 'title' => 'Mailer Cron Job Limit',
2456 'is_domain' => 1,
2457 'is_contact' => 0,
2458 'description' => 'The maximum number of mailer delivery jobs executing simultaneously (0 = allow as many processes to execute as started by cron)',
2459 'help_text' => '',
2460 ],
2461 'mailThrottleTime' => [
2462 'group_name' => 'Mailing Preferences',
2463 'group' => 'mailing',
2464 'name' => 'mailThrottleTime',
2465 'type' => 'Integer',
2466 'quick_form_type' => 'Element',
2467 'html_type' => 'text',
2468 'html_attributes' => [
2469 'size' => 4,
2470 'maxlength' => 8,
2471 ],
2472 'default' => 0,
2473 'add' => '4.7',
2474 'title' => 'Mailer Throttle Time',
2475 'is_domain' => 1,
2476 'is_contact' => 0,
2477 'description' => 'The time to sleep in between each e-mail in micro seconds. Setting this above 0 allows you to control the rate at which e-mail messages are sent to the mail server, avoiding filling up the mail queue very quickly. Set to 0 to disable.',
2478 'help_text' => '',
2479 ],
2480 'verpSeparator' => [
2481 'group_name' => 'Mailing Preferences',
2482 'group' => 'mailing',
2483 'name' => 'verpSeparator',
2484 'type' => 'String',
2485 'quick_form_type' => 'Element',
2486 'html_type' => 'text',
2487 'html_attributes' => [
2488 'size' => 4,
2489 'maxlength' => 32,
2490 ],
2491 'default' => '.',
2492 'add' => '4.7',
2493 'title' => 'VERP Separator',
2494 'is_domain' => 1,
2495 'is_contact' => 0,
2496 'description' => 'Separator character used when CiviMail generates VERP (variable envelope return path) Mail-From addresses.',
2497 'help_text' => '',
2498 ],
2499 'write_activity_record' => [
2500 'group_name' => 'Mailing Preferences',
2501 'group' => 'mailing',
2502 'name' => 'write_activity_record',
2503 'type' => 'Boolean',
2504 'html_type' => 'checkbox',
2505 'quick_form_type' => 'CheckBox',
2506 'default' => '1',
2507 'add' => '4.7',
2508 'title' => 'Enable CiviMail to create activities on delivery',
2509 'is_domain' => 1,
2510 'is_contact' => 0,
2511 'description' => '',
2512 'help_text' => '',
2513 ],
2514 'simple_mail_limit' => [
2515 'group_name' => 'Mailing Preferences',
2516 'group' => 'mailing',
2517 'name' => 'simple_mail_limit',
2518 'type' => 'Integer',
2519 'quick_form_type' => 'Element',
2520 'html_type' => 'text',
2521 'html_attributes' => [
2522 'size' => 4,
2523 'maxlength' => 8,
2524 ],
2525 'default' => 50,
2526 'title' => 'Simple mail limit',
2527 'is_domain' => 1,
2528 'is_contact' => 0,
2529 'description' => 'The number of emails sendable via simple mail. Make sure you understand the implications for your spam reputation and legal requirements for bulk emails before editing. As there is some risk both to your spam reputation and the products if this is misused it is a hidden setting',
2530 'help_text' => 'CiviCRM forces users sending more than this number of mails to use CiviMails. CiviMails have additional precautions: not sending to contacts who do not want bulk mail, adding domain name and opt out links. You should familiarise yourself with the law relevant to you on bulk mailings if changing this setting. For the US https://en.wikipedia.org/wiki/CAN-SPAM_Act_of_2003 is a good place to start.',
2531 ],
2532 'auto_recipient_rebuild' => [
2533 'group_name' => 'Mailing Preferences',
2534 'group' => 'mailing',
2535 'name' => 'auto_recipient_rebuild',
2536 'type' => 'Boolean',
2537 'html_type' => 'checkbox',
2538 'quick_form_type' => 'CheckBox',
2539 'default' => '1',
2540 'title' => 'Enable automatic CiviMail recipient count display',
2541 'is_domain' => 1,
2542 'is_contact' => 0,
2543 'description' => 'Enable this setting to rebuild recipient list automatically during composing mail. Disable will allow you to rebuild recipient manually.',
2544 'help_text' => 'CiviMail automatically fetches recipient list and count whenever mailing groups are included or excluded while composing bulk mail. This phenomena may degrade performance for large sites, so disable this setting to build and fetch recipients for selected groups, manually.',
2545 ],
2546 'allow_mail_from_logged_in_contact' => [
2547 'group_name' => 'Mailing Preferences',
2548 'group' => 'mailing',
2549 'name' => 'allow_mail_from_logged_in_contact',
2550 'type' => 'Boolean',
2551 'quick_form_type' => 'YesNo',
2552 'default' => 1,
2553 'title' => 'Allow mail from logged in contact',
2554 'is_domain' => 1,
2555 'is_contact' => 0,
2556 'description' => 'Allow sending email from the logged in contact\'s email address',
2557 'help_text' => 'CiviCRM allows you to send email from the domain from email addresses and the logged in contact id addresses by default. Disable this if you only want to allow the domain from addresses to be used.',
2558 ],
2559 'geoAPIKey' => [
2560 'add' => '4.7',
2561 'help_text' => '',
2562 'is_domain' => 1,
2563 'is_contact' => 0,
2564 'group_name' => 'Map Preferences',
2565 'group' => 'map',
2566 'name' => 'geoAPIKey',
2567 'type' => 'String',
2568 'quick_form_type' => 'Element',
2569 'html_type' => 'text',
2570 'html_attributes' => [
2571 'size' => '32',
2572 'maxlength' => '64',
2573 ],
2574 'default' => '',
2575 'title' => 'Geo Provider Key',
2576 'description' => 'Enter the API key or Application ID associated with your geocoding provider (not required for Yahoo).',
2577 ],
2578 'geoProvider' => [
2579 'add' => '4.7',
2580 'help_text' => '',
2581 'is_domain' => 1,
2582 'is_contact' => 0,
2583 'group_name' => 'Map Preferences',
2584 'group' => 'map',
2585 'name' => 'geoProvider',
2586 'type' => 'String',
2587 'quick_form_type' => 'Select',
2588 'html_type' => 'Select',
2589 'html_attributes' => [
2590 'class' => 'crm-select2',
2591 ],
2592 'pseudoconstant' => [
2593 'callback' => 'CRM_Core_SelectValues::geoProvider',
2594 ],
2595 'default' => '',
2596 'title' => 'Geocoding Provider',
2597 'description' => 'This can be the same or different from the mapping provider selected.',
2598 ],
2599 'mapAPIKey' => [
2600 'add' => '4.7',
2601 'help_text' => '',
2602 'is_domain' => 1,
2603 'is_contact' => 0,
2604 'group_name' => 'Map Preferences',
2605 'group' => 'map',
2606 'name' => 'mapAPIKey',
2607 'type' => 'String',
2608 'quick_form_type' => 'Element',
2609 'html_type' => 'text',
2610 'html_attributes' => [
2611 'size' => '32',
2612 'maxlength' => '64',
2613 ],
2614 'default' => '',
2615 'title' => 'Map Provider Key',
2616 'description' => 'Enter your API Key or Application ID. An API Key is required for the Google Maps API. Refer to developers.google.com for the latest information.',
2617 ],
2618 'mapProvider' => [
2619 'add' => '4.7',
2620 'help_text' => '',
2621 'is_domain' => 1,
2622 'is_contact' => 0,
2623 'group_name' => 'Map Preferences',
2624 'group' => 'map',
2625 'name' => 'mapProvider',
2626 'type' => 'String',
2627 'quick_form_type' => 'Select',
2628 'html_type' => 'Select',
2629 'html_attributes' => [
2630 'class' => 'crm-select2',
2631 ],
2632 'pseudoconstant' => [
2633 'callback' => 'CRM_Core_SelectValues::mapProvider',
2634 ],
2635 'default' => '',
2636 'title' => 'Mapping Provider',
2637 'description' => 'Choose the mapping provider that has the best coverage for the majority of your contact addresses.',
2638 ],
2639 'default_renewal_contribution_page' => [
2640 'group_name' => 'Member Preferences',
2641 'group' => 'member',
2642 'name' => 'default_renewal_contribution_page',
2643 'type' => 'Integer',
2644 'html_type' => 'select',
2645 'default' => '',
2646 'pseudoconstant' => [
2647 'callback' => 'CRM_Contribute_PseudoConstant::contributionPage',
2648 ],
2649 'add' => '4.1',
2650 'title' => 'Default online membership renewal page',
2651 'is_domain' => 1,
2652 'is_contact' => 0,
2653 '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.',
2654 'help_text' => '',
2655 ],
2656 'is_enabled' => [
2657 'group_name' => 'Multi Site Preferences',
2658 'group' => 'multisite',
2659 'name' => 'is_enabled',
2660 'title' => 'Enable Multi Site Configuration',
2661 'html_type' => 'checkbox',
2662 'type' => 'Boolean',
2663 'default' => 0,
2664 'add' => '4.1',
2665 'is_domain' => 1,
2666 'is_contact' => 0,
2667 'description' => 'Make CiviCRM aware of multiple domains. You should configure a domain group if enabled',
2668 'documentation_link' => [
2669 'page' => 'Multi Site Installation',
2670 'resource' => 'wiki',
2671 ],
2672 'help_text' => '',
2673 'settings_pages' => [
2674 'multisite' => [
2675 'weight' => 10,
2676 ],
2677 ],
2678 ],
2679 'domain_group_id' => [
2680 'group_name' => 'Multi Site Preferences',
2681 'group' => 'multisite',
2682 'name' => 'domain_group_id',
2683 'title' => 'Multisite Domain Group',
2684 'type' => 'Integer',
2685 'html_type' => 'entity_reference',
2686 'entity_reference_options' => [
2687 'entity' => 'Group',
2688 'select' => [
2689 'minimumInputLength' => 0,
2690 ],
2691 ],
2692 'default' => 0,
2693 'add' => '4.1',
2694 'is_domain' => 1,
2695 'is_contact' => 0,
2696 'description' => 'Contacts created on this site are added to this group',
2697 'help_text' => '',
2698 'settings_pages' => [
2699 'multisite' => [
2700 'weight' => 20,
2701 ],
2702 ],
2703 ],
2704 'event_price_set_domain_id' => [
2705 'group_name' => 'Multi Site Preferences',
2706 'group' => 'multisite',
2707 'name' => 'event_price_set_domain_id',
2708 'title' => 'Domain Event Price Set',
2709 'type' => 'Integer',
2710 'default' => 0,
2711 'add' => '4.1',
2712 'is_domain' => 1,
2713 'is_contact' => 0,
2714 'description' => '',
2715 'help_text' => '',
2716 ],
2717 'uniq_email_per_site' => [
2718 'group_name' => 'Multi Site Preferences',
2719 'group' => 'multisite',
2720 'name' => 'uniq_email_per_site',
2721 'type' => 'Integer',
2722 'title' => 'Unique Email per Domain?',
2723 'default' => 0,
2724 'add' => '4.1',
2725 'is_domain' => 1,
2726 'is_contact' => 0,
2727 'description' => '',
2728 'help_text' => '',
2729 ],
2730 'search_autocomplete_count' => [
2731 'group_name' => 'Search Preferences',
2732 'group' => 'Search Preferences',
2733 'name' => 'search_autocomplete_count',
2734 'type' => 'Integer',
2735 'quick_form_type' => 'Element',
2736 'html_type' => 'number',
2737 'default' => 10,
2738 'add' => '4.3',
2739 'title' => 'Autocomplete Results',
2740 'is_domain' => 1,
2741 'is_contact' => 0,
2742 'description' => 'The maximum number of contacts to show at a time when typing in an autocomplete field.',
2743 'help_text' => '',
2744 ],
2745 'enable_innodb_fts' => [
2746 'group_name' => 'Search Preferences',
2747 'group' => 'Search Preferences',
2748 'name' => 'enable_innodb_fts',
2749 'type' => 'Boolean',
2750 'quick_form_type' => 'YesNo',
2751 'default' => 0,
2752 'add' => '4.4',
2753 'title' => 'InnoDB Full Text Search',
2754 'is_domain' => 1,
2755 'is_contact' => 0,
2756 'description' => 'Enable InnoDB full-text search optimizations. (Requires MySQL 5.6+)',
2757 'help_text' => '',
2758 'on_change' => [
2759 '0' => [
2760 '0' => 'CRM_Core_InnoDBIndexer',
2761 '1' => 'onToggleFts',
2762 ],
2763 ],
2764 ],
2765 'fts_query_mode' => [
2766 'group_name' => 'Search Preferences',
2767 'group' => 'Search Preferences',
2768 'name' => 'fts_query_mode',
2769 'type' => 'String',
2770 'quick_form_type' => 'Element',
2771 'html_attributes' => [
2772 'size' => 64,
2773 'maxlength' => 64,
2774 ],
2775 'html_type' => 'text',
2776 'default' => 'simple',
2777 'add' => '4.5',
2778 'title' => 'How to handle full-text queries',
2779 'is_domain' => 1,
2780 'is_contact' => 0,
2781 'description' => '',
2782 'help_text' => '',
2783 ],
2784 'includeOrderByClause' => [
2785 'group_name' => 'Search Preferences',
2786 'group' => 'Search Preferences',
2787 'name' => 'includeOrderByClause',
2788 'type' => 'Boolean',
2789 'quick_form_type' => 'YesNo',
2790 'default' => 1,
2791 'add' => '4.6',
2792 'title' => 'Include Order By Clause',
2793 'is_domain' => 1,
2794 'is_contact' => 0,
2795 'description' => 'If disabled, the search results will not be ordered. This may improve response time on search results on large datasets',
2796 'help_text' => '',
2797 ],
2798 'includeWildCardInName' => [
2799 'group_name' => 'Search Preferences',
2800 'group' => 'Search Preferences',
2801 'name' => 'includeWildCardInName',
2802 'type' => 'Boolean',
2803 'quick_form_type' => 'YesNo',
2804 'default' => 1,
2805 'add' => '4.6',
2806 'title' => 'Automatic Wildcard',
2807 'is_domain' => 1,
2808 'is_contact' => 0,
2809 'description' => 'If enabled, wildcards are automatically added to the beginning AND end of the search term when users search for contacts by Name. EXAMPLE: Searching for \'ada\' will return any contact whose name includes those letters - e.g. \'Adams, Janet\', \'Nadal, Jorge\', etc. If disabled, a wildcard is added to the end of the search term only. EXAMPLE: Searching for \'ada\' will return any contact whose last name begins with those letters - e.g. \'Adams, Janet\' but NOT \'Nadal, Jorge\'. Disabling this feature will speed up search significantly for larger databases, but users must manually enter wildcards (\'%\' or \'_\') to the beginning of the search term if they want to find all records which contain those letters. EXAMPLE: \'%ada\' will return \'Nadal, Jorge\'.',
2810 'help_text' => '',
2811 ],
2812 'includeEmailInName' => [
2813 'group_name' => 'Search Preferences',
2814 'group' => 'Search Preferences',
2815 'name' => 'includeEmailInName',
2816 'type' => 'Boolean',
2817 'quick_form_type' => 'YesNo',
2818 'default' => 1,
2819 'add' => '4.6',
2820 'title' => 'Include Email',
2821 'is_domain' => 1,
2822 'is_contact' => 0,
2823 'description' => 'If enabled, email addresses are automatically included when users search by Name. Disabling this feature will speed up search significantly for larger databases, but users will need to use the Email search fields (from Advanced Search, Search Builder, or Profiles) to find contacts by email address.',
2824 'help_text' => '',
2825 ],
2826 'includeNickNameInName' => [
2827 'group_name' => 'Search Preferences',
2828 'group' => 'Search Preferences',
2829 'name' => 'includeNickNameInName',
2830 'type' => 'Boolean',
2831 'quick_form_type' => 'YesNo',
2832 'default' => 0,
2833 'add' => '4.6',
2834 'title' => 'Include Nickname',
2835 'is_domain' => 1,
2836 'is_contact' => 0,
2837 'description' => 'If enabled, nicknames are automatically included when users search by Name.',
2838 'help_text' => '',
2839 ],
2840 'includeAlphabeticalPager' => [
2841 'group_name' => 'Search Preferences',
2842 'group' => 'Search Preferences',
2843 'name' => 'includeAlphabeticalPager',
2844 'type' => 'Boolean',
2845 'quick_form_type' => 'YesNo',
2846 'default' => 1,
2847 'add' => '4.6',
2848 'title' => 'Include Alphabetical Pager',
2849 'is_domain' => 1,
2850 'is_contact' => 0,
2851 'description' => 'If disabled, the alphabetical pager will not be displayed on the search screens. This will improve response time on search results on large datasets.',
2852 'help_text' => '',
2853 ],
2854 'smartGroupCacheTimeout' => [
2855 'group_name' => 'Search Preferences',
2856 'group' => 'Search Preferences',
2857 'name' => 'smartGroupCacheTimeout',
2858 'type' => 'Integer',
2859 'quick_form_type' => 'Element',
2860 'html_type' => 'number',
2861 'default' => 5,
2862 'add' => '4.6',
2863 'title' => 'Smart group cache timeout',
2864 'is_domain' => 1,
2865 'is_contact' => 0,
2866 'description' => 'The number of minutes to cache smart group contacts. We strongly recommend that this value be greater than zero, since a value of zero means no caching at all. If your contact data changes frequently, you should set this value to at least 5 minutes.',
2867 'help_text' => '',
2868 ],
2869 'defaultSearchProfileID' => [
2870 'group_name' => 'Search Preferences',
2871 'group' => 'Search Preferences',
2872 'name' => 'defaultSearchProfileID',
2873 'type' => 'Integer',
2874 'quick_form_type' => 'Select',
2875 'html_type' => 'Select',
2876 'html_attributes' => [
2877 'class' => 'crm-select2',
2878 ],
2879 'pseudoconstant' => [
2880 'callback' => 'CRM_Admin_Form_Setting_Search::getAvailableProfiles',
2881 ],
2882 'default' => '',
2883 'add' => '4.6',
2884 'title' => 'Default Contact Search Profile',
2885 'is_domain' => 1,
2886 'is_contact' => 0,
2887 'description' => 'If set, this will be the default profile used for contact search.',
2888 'help_text' => '',
2889 ],
2890 'prevNextBackend' => [
2891 'group_name' => 'Search Preferences',
2892 'group' => 'Search Preferences',
2893 'name' => 'prevNextBackend',
2894 'type' => 'String',
2895 'quick_form_type' => 'Select',
2896 'html_type' => 'Select',
2897 'html_attributes' => [],
2898 'default' => 'default',
2899 'add' => '5.9',
2900 'title' => 'PrevNext Cache',
2901 'is_domain' => 1,
2902 'is_contact' => 0,
2903 'pseudoconstant' => [
2904 'callback' => 'CRM_Core_BAO_PrevNextCache::getPrevNextBackends',
2905 ],
2906 'description' => 'When performing a search, how should the search-results be cached?',
2907 'help_text' => '',
2908 ],
2909 'searchPrimaryDetailsOnly' => [
2910 'group_name' => 'Search Preferences',
2911 'group' => 'Search Preferences',
2912 'name' => 'searchPrimaryDetailsOnly',
2913 'type' => 'Boolean',
2914 'quick_form_type' => 'YesNo',
2915 'default' => 1,
2916 'add' => '4.7',
2917 'title' => 'Search Primary Details Only',
2918 'is_domain' => 1,
2919 'is_contact' => 0,
2920 'description' => 'If enabled, only primary details (eg contact\'s primary email, phone, etc) will be included in Basic and Advanced Search results. Disabling this feature will allow users to match contacts using any email, phone etc detail.',
2921 'help_text' => '',
2922 ],
2923 'quicksearch_options' => [
2924 'group_name' => 'Search Preferences',
2925 'group' => 'Search Preferences',
2926 'name' => 'quicksearch_options',
2927 'type' => 'string',
2928 'serialize' => 1,
2929 'html_type' => 'checkboxes',
2930 'sortable' => TRUE,
2931 'pseudoconstant' => [
2932 'callback' => 'CRM_Core_SelectValues::quicksearchOptions',
2933 ],
2934 'default' => [
2935 '0' => 'sort_name',
2936 '1' => 'contact_id',
2937 '2' => 'external_identifier',
2938 '3' => 'first_name',
2939 '4' => 'last_name',
2940 '5' => 'email',
2941 '6' => 'phone_numeric',
2942 '7' => 'street_address',
2943 '8' => 'city',
2944 '9' => 'postal_code',
2945 '10' => 'job_title',
2946 ],
2947 'add' => '5.8',
2948 'title' => 'Quicksearch options',
2949 'is_domain' => '1',
2950 'is_contact' => 0,
2951 'description' => 'Which fields can be searched on in the menubar quicksearch box? Don\'t see your custom field here? Make sure it is marked as Searchable.',
2952 'help_text' => '',
2953 ],
2954 'userFrameworkResourceURL' => [
2955 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
2956 'group' => 'url',
2957 'group_name' => 'URL Preferences',
2958 'name' => 'userFrameworkResourceURL',
2959 'title' => 'CiviCRM Resource URL',
2960 'type' => 'String',
2961 'html_type' => 'text',
2962 'quick_form_type' => 'Element',
2963 'default' => '',
2964 'add' => '4.1',
2965 'is_domain' => 1,
2966 'is_contact' => 0,
2967 'description' => 'Absolute URL of the location where the civicrm module or component has been installed.',
2968 'help_text' => '',
2969 'validate_callback' => 'CRM_Utils_Rule::urlish',
2970 ],
2971 'imageUploadURL' => [
2972 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
2973 'group' => 'url',
2974 'group_name' => 'URL Preferences',
2975 'title' => 'Image Upload URL',
2976 'name' => 'imageUploadURL',
2977 'type' => 'String',
2978 'html_type' => 'text',
2979 'quick_form_type' => 'Element',
2980 'default' => '',
2981 'add' => '4.1',
2982 'is_domain' => 1,
2983 'is_contact' => 0,
2984 'description' => 'URL of the location for uploaded image files.',
2985 'help_text' => '',
2986 'validate_callback' => 'CRM_Utils_Rule::urlish',
2987 ],
2988 'customCSSURL' => [
2989 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
2990 'group' => 'url',
2991 'group_name' => 'URL Preferences',
2992 'name' => 'customCSSURL',
2993 'title' => 'Custom CSS URL',
2994 'type' => 'String',
2995 'html_type' => 'text',
2996 'quick_form_type' => 'Element',
2997 'default' => '',
2998 'add' => '4.1',
2999 'is_domain' => 1,
3000 'is_contact' => 0,
3001 'description' => 'You can modify the look and feel of CiviCRM by adding your own stylesheet. For small to medium sized modifications, use your css file to override some of the styles in civicrm.css. Or if you need to make drastic changes, you can choose to disable civicrm.css completely.',
3002 'help_text' => '',
3003 'validate_callback' => 'CRM_Utils_Rule::urlish',
3004 ],
3005 'extensionsURL' => [
3006 'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
3007 'group' => 'url',
3008 'group_name' => 'URL Preferences',
3009 'title' => 'Extension Resource URL',
3010 'name' => 'extensionsURL',
3011 'type' => 'String',
3012 'html_type' => 'text',
3013 'quick_form_type' => 'Element',
3014 'default' => '',
3015 'add' => '4.1',
3016 'is_domain' => 1,
3017 'is_contact' => 0,
3018 'description' => 'Base URL for extension resources (images, stylesheets, etc). This should match extensionsDir.',
3019 'help_text' => '',
3020 'validate_callback' => 'CRM_Utils_Rule::urlish',
3021 ],
3022 ],
3023 ];
3024
3025 return $expectedResult;
3026 }
3027
3028 /*
3029 * This example has been generated from the API test suite.
3030 * The test that created it is called "testGetFields"
3031 * and can be found at:
3032 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.php
3033 *
3034 * You can see the outcome of the API tests at
3035 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
3036 *
3037 * To Learn about the API read
3038 * https://docs.civicrm.org/dev/en/latest/api/
3039 *
3040 * Browse the API on your own site with the API Explorer. It is in the main
3041 * CiviCRM menu, under: Support > Development > API Explorer.
3042 *
3043 * Read more about testing here
3044 * https://docs.civicrm.org/dev/en/latest/testing/
3045 *
3046 * API Standards documentation:
3047 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
3048 */