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