settings/Localization.setting.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 /*
  18  * Settings metadata file
  19  */
  20
  21 return [
  22   'customTranslateFunction' => [
  23     'add' => '4.7',
  24     'help_text' => NULL,
  25     'is_domain' => 1,
  26     'is_contact' => 0,
  27     'group_name' => 'Localization Preferences',
  28     'group' => 'localization',
  29     'name' => 'customTranslateFunction',
  30     'type' => 'String',
  31     'quick_form_type' => 'Element',
  32     'html_type' => 'text',
  33     'html_attributes' => [
  34       'size' => '30',
  35       'maxlength' => '100',
  36     ],
  37     'default' => NULL,
  38     'title' => ts('Custom Translate Function'),
  39   ],
  40   'monetaryThousandSeparator' => [
  41     'group_name' => 'Localization Preferences',
  42     'group' => 'localization',
  43     'name' => 'monetaryThousandSeparator',
  44     'type' => 'String',
  45     'quick_form_type' => 'Element',
  46     'html_type' => 'text',
  47     'html_attributes' => [
  48       'size' => 2,
  49     ],
  50     'default' => ',',
  51     'add' => '4.3',
  52     'title' => ts('Thousands Separator'),
  53     'is_domain' => 1,
  54     'is_contact' => 0,
  55     'help_text' => NULL,
  56   ],
  57   'monetaryDecimalPoint' => [
  58     'group_name' => 'Localization Preferences',
  59     'group' => 'localization',
  60     'name' => 'monetaryDecimalPoint',
  61     'type' => 'String',
  62     'quick_form_type' => 'Element',
  63     'html_type' => 'text',
  64     'html_attributes' => [
  65       'size' => 2,
  66     ],
  67     'default' => '.',
  68     'add' => '4.3',
  69     'title' => ts('Decimal Delimiter'),
  70     'is_domain' => 1,
  71     'is_contact' => 0,
  72     'help_text' => NULL,
  73   ],
  74   'moneyformat' => [
  75     'group_name' => 'Localization Preferences',
  76     'group' => 'localization',
  77     'name' => 'moneyformat',
  78     'type' => 'String',
  79     'quick_form_type' => 'Element',
  80     'html_type' => 'text',
  81     'default' => '%c %a',
  82     'add' => '4.3',
  83     'title' => ts('Monetary Amount Display'),
  84     'is_domain' => 1,
  85     'is_contact' => 0,
  86     'help_text' => NULL,
  87   ],
  88   'moneyvalueformat' => [
  89     'group_name' => 'Localization Preferences',
  90     'group' => 'localization',
  91     'name' => 'moneyvalueformat',
  92     'type' => 'String',
  93     'quick_form_type' => 'Element',
  94     'html_type' => 'text',
  95     'default' => '%!i',
  96     'add' => '4.3',
  97     'title' => ts('Monetary Value Display'),
  98     'is_domain' => 1,
  99     'is_contact' => 0,
 100     'help_text' => NULL,
 101   ],
 102   'defaultCurrency' => [
 103     'group_name' => 'Localization Preferences',
 104     'group' => 'localization',
 105     'name' => 'defaultCurrency',
 106     'type' => 'String',
 107     'quick_form_type' => 'Select',
 108     'html_type' => 'Select',
 109     'html_attributes' => [
 110       'class' => 'crm-select2',
 111     ],
 112     'default' => 'USD',
 113     'add' => '4.3',
 114     'title' => ts('Default Currency'),
 115     'is_domain' => 1,
 116     'is_contact' => 0,
 117     'description' => ts('Default currency assigned to contributions and other monetary transactions.'),
 118     'help_text' => NULL,
 119     'pseudoconstant' => [
 120       'callback' => 'CRM_Admin_Form_Setting_Localization::getCurrencySymbols',
 121     ],
 122     'on_change' => [
 123       'CRM_Admin_Form_Setting_Localization::onChangeDefaultCurrency',
 124     ],
 125   ],
 126   'defaultContactCountry' => [
 127     'group_name' => 'Localization Preferences',
 128     'group' => 'localization',
 129     'name' => 'defaultContactCountry',
 130     'type' => 'String',
 131     'quick_form_type' => 'Select',
 132     'html_type' => 'Select',
 133     'html_attributes' => [
 134       //'class' => 'crm-select2',
 135     ],
 136     'add' => '4.4',
 137     'title' => ts('Default Country'),
 138     'is_domain' => 1,
 139     'is_contact' => 0,
 140     'is_required' => FALSE,
 141     'description' => ts('This value is selected by default when adding a new contact address.'),
 142     'help_text' => NULL,
 143     'pseudoconstant' => [
 144       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 145     ],
 146   ],
 147   'defaultContactStateProvince' => [
 148     'add' => '4.7',
 149     'help_text' => NULL,
 150     'is_domain' => 1,
 151     'is_contact' => 0,
 152     'group_name' => 'Localization Preferences',
 153     'group' => 'localization',
 154     'name' => 'defaultContactStateProvince',
 155     'type' => 'Integer',
 156     'quick_form_type' => 'ChainSelect',
 157     'html_type' => 'ChainSelect',
 158     'chain_select_settings' => [
 159       'control_field' => 'defaultContactCountry',
 160     ],
 161     //'pseudoconstant' => array(
 162     //  'callback' => 'CRM_Core_PseudoConstant::stateProvince',
 163     //),
 164     //'html_attributes',
 165     'default' => NULL,
 166     'title' => ts('Default State/Province'),
 167     'description' => ts('This value is selected by default when adding a new contact address.'),
 168   ],
 169   'countryLimit' => [
 170     'group_name' => 'Localization Preferences',
 171     'group' => 'localization',
 172     'name' => 'countryLimit',
 173     'type' => 'Array',
 174     'quick_form_type' => 'Element',
 175     'html_type' => 'advmultiselect',
 176     'html_attributes' => [
 177       'size' => 5,
 178       'style' => 'width:150px',
 179       'class' => 'advmultiselect',
 180     ],
 181     'default' => [],
 182     'add' => '4.3',
 183     'title' => ts('Available Countries'),
 184     'is_domain' => 1,
 185     'is_contact' => 0,
 186     'help_text' => NULL,
 187     'pseudoconstant' => [
 188       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 189     ],
 190   ],
 191   'provinceLimit' => [
 192     'group_name' => 'Localization Preferences',
 193     'group' => 'localization',
 194     'name' => 'provinceLimit',
 195     'type' => 'Array',
 196     'quick_form_type' => 'Element',
 197     'html_type' => 'advmultiselect',
 198     'html_attributes' => [
 199       'size' => 5,
 200       'style' => 'width:150px',
 201       'class' => 'advmultiselect',
 202     ],
 203     'default' => [],
 204     'add' => '4.3',
 205     'title' => ts('Available States and Provinces (by Country)'),
 206     'is_domain' => 1,
 207     'is_contact' => 0,
 208     'help_text' => NULL,
 209     'pseudoconstant' => [
 210       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 211     ],
 212   ],
 213   'inheritLocale' => [
 214     'group_name' => 'Localization Preferences',
 215     'group' => 'localization',
 216     'name' => 'inheritLocale',
 217     'type' => 'Boolean',
 218     'quick_form_type' => 'YesNo',
 219     'default' => '0',
 220     'add' => '4.3',
 221     'title' => ts('Inherit CMS Language'),
 222     'is_domain' => 1,
 223     'is_contact' => 0,
 224     'help_text' => NULL,
 225     'description' => ts('If Yes, the initial session language will be set by the CMS, which can later be changed if using the CiviCRM language switcher.'),
 226   ],
 227   'dateformatDatetime' => [
 228     'group_name' => 'Localization Preferences',
 229     'group' => 'localization',
 230     'name' => 'dateformatDatetime',
 231     'type' => 'String',
 232     'quick_form_type' => 'Element',
 233     'html_type' => 'text',
 234     'default' => '%B %E%f, %Y %l:%M %P',
 235     'add' => '4.3',
 236     'title' => ts('Date Format: Complete Date and Time'),
 237     'is_domain' => 1,
 238     'is_contact' => 0,
 239     'help_text' => NULL,
 240   ],
 241   'dateformatFull' => [
 242     'group_name' => 'Localization Preferences',
 243     'group' => 'localization',
 244     'name' => 'dateformatFull',
 245     'type' => 'String',
 246     'quick_form_type' => 'Element',
 247     'html_type' => 'text',
 248     'default' => '%B %E%f, %Y',
 249     'add' => '4.3',
 250     'title' => ts('Date Format: Complete Date'),
 251     'is_domain' => 1,
 252     'is_contact' => 0,
 253     'help_text' => NULL,
 254   ],
 255   'dateformatPartial' => [
 256     'group_name' => 'Localization Preferences',
 257     'group' => 'localization',
 258     'name' => 'dateformatPartial',
 259     'type' => 'String',
 260     'quick_form_type' => 'Element',
 261     'html_type' => 'text',
 262     'default' => '%B %Y',
 263     'add' => '4.3',
 264     'title' => ts('Date Format: Month and Year'),
 265     'is_domain' => 1,
 266     'is_contact' => 0,
 267     'help_text' => NULL,
 268   ],
 269   'dateformatTime' => [
 270     'add' => '4.7',
 271     'help_text' => NULL,
 272     'is_domain' => 1,
 273     'is_contact' => 0,
 274     'group_name' => 'Localization Preferences',
 275     'group' => 'localization',
 276     'name' => 'dateformatTime',
 277     'type' => 'String',
 278     'quick_form_type' => 'Element',
 279     'html_type' => 'text',
 280     'html_attributes' => [
 281       'size' => '12',
 282       'maxlength' => '60',
 283     ],
 284     'default' => '%l:%M %P',
 285     'title' => ts('Date Format: Time Only'),
 286   ],
 287   'dateformatYear' => [
 288     'add' => '4.7',
 289     'help_text' => NULL,
 290     'is_domain' => 1,
 291     'is_contact' => 0,
 292     'group_name' => 'Localization Preferences',
 293     'group' => 'localization',
 294     'name' => 'dateformatYear',
 295     'type' => 'String',
 296     'quick_form_type' => 'Element',
 297     'html_type' => 'text',
 298     'html_attributes' => [
 299       'size' => '12',
 300       'maxlength' => '60',
 301     ],
 302     'default' => '%Y',
 303     'title' => ts('Date Format: Year Only'),
 304   ],
 305   'dateformatFinancialBatch' => [
 306     'add' => '4.7',
 307     'help_text' => NULL,
 308     'is_domain' => 1,
 309     'is_contact' => 0,
 310     'group_name' => 'Localization Preferences',
 311     'group' => 'localization',
 312     'name' => 'dateformatFinancialBatch',
 313     'type' => 'String',
 314     'quick_form_type' => 'Element',
 315     'html_type' => 'text',
 316     'html_attributes' => [
 317       'size' => '12',
 318       'maxlength' => '60',
 319     ],
 320     'default' => '%m/%d/%Y',
 321     'title' => ts('Date Format: Financial Batch'),
 322   ],
 323   'dateformatshortdate' => [
 324     'add' => '4.7',
 325     'help_text' => NULL,
 326     'is_domain' => 1,
 327     'is_contact' => 0,
 328     'group_name' => 'Localization Preferences',
 329     'group' => 'localization',
 330     'name' => 'dateformatshortdate',
 331     'type' => 'String',
 332     'quick_form_type' => 'Element',
 333     'html_type' => 'text',
 334     'html_attributes' => [
 335       'size' => '12',
 336       'maxlength' => '60',
 337     ],
 338     'default' => '%m/%d/%Y',
 339     'title' => ts('Date Format: Short date Month Day Year'),
 340   ],
 341   'dateInputFormat' => [
 342     'add' => '4.7',
 343     'help_text' => NULL,
 344     'is_domain' => 1,
 345     'is_contact' => 0,
 346     'group_name' => 'Localization Preferences',
 347     'group' => 'localization',
 348     'name' => 'dateInputFormat',
 349     'type' => 'String',
 350     'quick_form_type' => 'Select',
 351     'html_type' => 'Select',
 352     'pseudoconstant' => [
 353       'callback' => 'CRM_Core_SelectValues::getDatePluginInputFormats',
 354     ],
 355     'default' => 'mm/dd/yy',
 356     'title' => ts('Date Input Format'),
 357   ],
 358   'fieldSeparator' => [
 359     'add' => '4.7',
 360     'help_text' => NULL,
 361     'is_domain' => 1,
 362     'is_contact' => 0,
 363     'group_name' => 'Localization Preferences',
 364     'group' => 'localization',
 365     'name' => 'fieldSeparator',
 366     'type' => 'String',
 367     'quick_form_type' => 'Element',
 368     'html_type' => 'text',
 369     'html_attributes' => [
 370       'size' => '2',
 371       'maxlength' => '8',
 372     ],
 373     'default' => ',',
 374     'title' => ts('Import / Export Field Separator'),
 375     'description' => ts('Global CSV separator character. Modify this setting to enable import and export of different kinds of CSV files (for example: \',\' \';\' \':\' \'|\' ).'),
 376   ],
 377   'fiscalYearStart' => [
 378     'add' => '4.7',
 379     'help_text' => NULL,
 380     'is_domain' => 1,
 381     'is_contact' => 0,
 382     'group_name' => 'Localization Preferences',
 383     'group' => 'localization',
 384     'name' => 'fiscalYearStart',
 385     'type' => 'Array',
 386     'quick_form_type' => 'MonthDay',
 387     'html_type' => 'MonthDay',
 388     'default' => ['M' => 1, 'd' => 1],
 389     'title' => ts('Fiscal Year Start'),
 390   ],
 391   'languageLimit' => [
 392     'group_name' => 'Localization Preferences',
 393     'group' => 'localization',
 394     'name' => 'languageLimit',
 395     'type' => 'Array',
 396     'quick_form_type' => 'Select',
 397     'html_type' => 'Select',
 398     'html_attributes' => [
 399       'multiple' => 1,
 400       'class' => 'crm-select2',
 401     ],
 402     'default' => NULL,
 403     'add' => '4.3',
 404     'title' => ts('Available Languages (Multi-lingual)'),
 405     'is_domain' => 1,
 406     'is_contact' => 0,
 407     'help_text' => NULL,
 408     'pseudoconstant' => [
 409       'callback' => 'CRM_Core_I18n::languages',
 410     ],
 411   ],
 412   'format_locale' => [
 413     'group_name' => 'Localization Preferences',
 414     'group' => 'localization',
 415     'name' => 'format_locale',
 416     'type' => 'String',
 417     'quick_form_type' => 'Select',
 418     'html_type' => 'Select',
 419     'html_attributes' => [
 420       'class' => 'crm-select2',
 421     ],
 422     'default' => NULL,
 423     'add' => '5.47',
 424     'title' => ts('Formatting locale'),
 425     'is_domain' => 1,
 426     'is_contact' => 0,
 427     'help_text' => NULL,
 428     'pseudoconstant' => [
 429       'callback' => 'CRM_Core_I18n::getFormatLocales',
 430     ],
 431     'description' => ts('Locale to use when formatting money (and in future dates). This replaces thousandsSeparator & decimalSeparator & moneyFormat settings.'),
 432   ],
 433   'uiLanguages' => [
 434     'group_name' => 'Localization Preferences',
 435     'group' => 'localization',
 436     'name' => 'uiLanguages',
 437     'type' => 'Array',
 438     'quick_form_type' => 'Select',
 439     'html_type' => 'select',
 440     'html_attributes' => [
 441       'multiple' => 1,
 442       'class' => 'crm-select2',
 443     ],
 444     'default' => NULL,
 445     'add' => '5.9',
 446     'title' => ts('Available Languages'),
 447     'is_domain' => 1,
 448     'is_contact' => 0,
 449     'help_text' => ts('User Interface languages available to users'),
 450     'pseudoconstant' => [
 451       'callback' => 'CRM_Core_I18n::languages',
 452     ],
 453   ],
 454   'lcMessages' => [
 455     'group_name' => 'Localization Preferences',
 456     'group' => 'localization',
 457     'name' => 'lcMessages',
 458     'type' => 'String',
 459     'quick_form_type' => 'Select',
 460     'html_type' => 'Select',
 461     'html_attributes' => [
 462       'class' => 'crm-select2',
 463     ],
 464     'default' => 'en_US',
 465     'add' => '4.3',
 466     'title' => ts('Default Language'),
 467     'is_domain' => 1,
 468     'is_contact' => 0,
 469     'help_text' => NULL,
 470     'pseudoconstant' => [
 471       'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLocaleOptions',
 472     ],
 473     'on_change' => [
 474       'CRM_Admin_Form_Setting_Localization::onChangeLcMessages',
 475     ],
 476   ],
 477   'legacyEncoding' => [
 478     'add' => '4.7',
 479     'help_text' => NULL,
 480     'is_domain' => 1,
 481     'is_contact' => 0,
 482     'group_name' => 'Localization Preferences',
 483     'group' => 'localization',
 484     'name' => 'legacyEncoding',
 485     'type' => 'String',
 486     'quick_form_type' => 'Element',
 487     'html_type' => 'text',
 488     'html_attributes' => [
 489       'size' => '12',
 490       'maxlength' => '30',
 491     ],
 492     'default' => 'Windows-1252',
 493     'title' => ts('Legacy Encoding'),
 494     'description' => ts('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.'),
 495   ],
 496   'timeInputFormat' => [
 497     'add' => '4.7',
 498     'help_text' => NULL,
 499     'is_domain' => 1,
 500     'is_contact' => 0,
 501     'group_name' => 'Localization Preferences',
 502     'group' => 'localization',
 503     'name' => 'timeInputFormat',
 504     'type' => 'String',
 505     'quick_form_type' => 'Select',
 506     'html_type' => 'Select',
 507     'pseudoconstant' => [
 508       'callback' => 'CRM_Core_SelectValues::getTimeFormats',
 509     ],
 510     'default' => '1',
 511     'title' => ts('Time Input Format'),
 512     'on_change' => [
 513       'CRM_Core_BAO_PreferencesDate::onChangeSetting',
 514     ],
 515   ],
 516   'weekBegins' => [
 517     'group_name' => 'Localization Preferences',
 518     'group' => 'localization',
 519     'name' => 'weekBegins',
 520     'type' => 'String',
 521     'quick_form_type' => 'Select',
 522     'html_type' => 'Select',
 523     'pseudoconstant' => [
 524       'callback' => 'CRM_Utils_Date::getFullWeekdayNames',
 525     ],
 526     'default' => '0',
 527     'add' => '4.7',
 528     'title' => ts('Week begins on'),
 529     'is_domain' => 1,
 530     'is_contact' => 0,
 531     'help_text' => NULL,
 532   ],
 533   'contact_default_language' => [
 534     'group_name' => 'Localization Preferences',
 535     'group' => 'localization',
 536     'name' => 'contact_default_language',
 537     'type' => 'String',
 538     'quick_form_type' => 'Select',
 539     'html_type' => 'Select',
 540     'html_attributes' => [
 541       'class' => 'crm-select2',
 542     ],
 543     'pseudoconstant' => [
 544       'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLanguageOptions',
 545     ],
 546     'default' => '*default*',
 547     'add' => '4.7',
 548     'title' => ts('Default Language for contacts'),
 549     'is_domain' => 1,
 550     'is_contact' => 0,
 551     'description' => ts('Default language (if any) for contact records.'),
 552     'help_text' => 'If a contact is created with no language this setting will determine the language data (if any) to save.'
 553     . 'You may or may not wish to make an assumption here about whether it matches the site language',
 554   ],
 555   'pinnedContactCountries' => [
 556     'group_name' => 'Localization Preferences',
 557     'group' => 'localization',
 558     'name' => 'pinnedContactCountries',
 559     'type' => 'Array',
 560     'quick_form_type' => 'Element',
 561     'html_type' => 'advmultiselect',
 562     'html_attributes' => [
 563       'size' => 5,
 564       'style' => 'width:150px',
 565       'class' => 'advmultiselect',
 566     ],
 567     'default' => [],
 568     'add' => '5.33',
 569     'title' => ts('Pinned Countries'),
 570     'is_domain' => 1,
 571     'is_contact' => 0,
 572     'description' => ts('Appear in Top section of select list'),
 573     'help_text' => ts('Selected countries will appear in top section of country list'),
 574     'pseudoconstant' => [
 575       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 576     ],
 577   ],
 578 ];