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