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     //'pseudoconstant' => array(
 159     //  'callback' => 'CRM_Core_PseudoConstant::stateProvince',
 160     //),
 161     //'html_attributes',
 162     'default' => NULL,
 163     'title' => ts('Default State/Province'),
 164     'description' => ts('This value is selected by default when adding a new contact address.'),
 165   ],
 166   'countryLimit' => [
 167     'group_name' => 'Localization Preferences',
 168     'group' => 'localization',
 169     'name' => 'countryLimit',
 170     'type' => 'Array',
 171     'quick_form_type' => 'Element',
 172     'html_type' => 'advmultiselect',
 173     'html_attributes' => [
 174       'size' => 5,
 175       'style' => 'width:150px',
 176       'class' => 'advmultiselect',
 177     ],
 178     'default' => [],
 179     'add' => '4.3',
 180     'title' => ts('Available Countries'),
 181     'is_domain' => 1,
 182     'is_contact' => 0,
 183     'help_text' => NULL,
 184     'pseudoconstant' => [
 185       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 186     ],
 187   ],
 188   'provinceLimit' => [
 189     'group_name' => 'Localization Preferences',
 190     'group' => 'localization',
 191     'name' => 'provinceLimit',
 192     'type' => 'Array',
 193     'quick_form_type' => 'Element',
 194     'html_type' => 'advmultiselect',
 195     'html_attributes' => [
 196       'size' => 5,
 197       'style' => 'width:150px',
 198       'class' => 'advmultiselect',
 199     ],
 200     'default' => [],
 201     'add' => '4.3',
 202     'title' => ts('Available States and Provinces (by Country)'),
 203     'is_domain' => 1,
 204     'is_contact' => 0,
 205     'help_text' => NULL,
 206     'pseudoconstant' => [
 207       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 208     ],
 209   ],
 210   'inheritLocale' => [
 211     'group_name' => 'Localization Preferences',
 212     'group' => 'localization',
 213     'name' => 'inheritLocale',
 214     'type' => 'Boolean',
 215     'quick_form_type' => 'YesNo',
 216     'default' => '0',
 217     'add' => '4.3',
 218     'title' => ts('Inherit CMS Language'),
 219     'is_domain' => 1,
 220     'is_contact' => 0,
 221     'help_text' => NULL,
 222     '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.'),
 223   ],
 224   'dateformatDatetime' => [
 225     'group_name' => 'Localization Preferences',
 226     'group' => 'localization',
 227     'name' => 'dateformatDatetime',
 228     'type' => 'String',
 229     'quick_form_type' => 'Element',
 230     'html_type' => 'text',
 231     'default' => '%B %E%f, %Y %l:%M %P',
 232     'add' => '4.3',
 233     'title' => ts('Date Format: Complete Date and Time'),
 234     'is_domain' => 1,
 235     'is_contact' => 0,
 236     'help_text' => NULL,
 237   ],
 238   'dateformatFull' => [
 239     'group_name' => 'Localization Preferences',
 240     'group' => 'localization',
 241     'name' => 'dateformatFull',
 242     'type' => 'String',
 243     'quick_form_type' => 'Element',
 244     'html_type' => 'text',
 245     'default' => '%B %E%f, %Y',
 246     'add' => '4.3',
 247     'title' => ts('Date Format: Complete Date'),
 248     'is_domain' => 1,
 249     'is_contact' => 0,
 250     'help_text' => NULL,
 251   ],
 252   'dateformatPartial' => [
 253     'group_name' => 'Localization Preferences',
 254     'group' => 'localization',
 255     'name' => 'dateformatPartial',
 256     'type' => 'String',
 257     'quick_form_type' => 'Element',
 258     'html_type' => 'text',
 259     'default' => '%B %Y',
 260     'add' => '4.3',
 261     'title' => ts('Date Format: Month and Year'),
 262     'is_domain' => 1,
 263     'is_contact' => 0,
 264     'help_text' => NULL,
 265   ],
 266   'dateformatTime' => [
 267     'add' => '4.7',
 268     'help_text' => NULL,
 269     'is_domain' => 1,
 270     'is_contact' => 0,
 271     'group_name' => 'Localization Preferences',
 272     'group' => 'localization',
 273     'name' => 'dateformatTime',
 274     'type' => 'String',
 275     'quick_form_type' => 'Element',
 276     'html_type' => 'text',
 277     'html_attributes' => [
 278       'size' => '12',
 279       'maxlength' => '60',
 280     ],
 281     'default' => '%l:%M %P',
 282     'title' => ts('Date Format: Time Only'),
 283   ],
 284   'dateformatYear' => [
 285     'add' => '4.7',
 286     'help_text' => NULL,
 287     'is_domain' => 1,
 288     'is_contact' => 0,
 289     'group_name' => 'Localization Preferences',
 290     'group' => 'localization',
 291     'name' => 'dateformatYear',
 292     'type' => 'String',
 293     'quick_form_type' => 'Element',
 294     'html_type' => 'text',
 295     'html_attributes' => [
 296       'size' => '12',
 297       'maxlength' => '60',
 298     ],
 299     'default' => '%Y',
 300     'title' => ts('Date Format: Year Only'),
 301   ],
 302   'dateformatFinancialBatch' => [
 303     'add' => '4.7',
 304     'help_text' => NULL,
 305     'is_domain' => 1,
 306     'is_contact' => 0,
 307     'group_name' => 'Localization Preferences',
 308     'group' => 'localization',
 309     'name' => 'dateformatFinancialBatch',
 310     'type' => 'String',
 311     'quick_form_type' => 'Element',
 312     'html_type' => 'text',
 313     'html_attributes' => [
 314       'size' => '12',
 315       'maxlength' => '60',
 316     ],
 317     'default' => '%m/%d/%Y',
 318     'title' => ts('Date Format: Financial Batch'),
 319   ],
 320   'dateformatshortdate' => [
 321     'add' => '4.7',
 322     'help_text' => NULL,
 323     'is_domain' => 1,
 324     'is_contact' => 0,
 325     'group_name' => 'Localization Preferences',
 326     'group' => 'localization',
 327     'name' => 'dateformatshortdate',
 328     'type' => 'String',
 329     'quick_form_type' => 'Element',
 330     'html_type' => 'text',
 331     'html_attributes' => [
 332       'size' => '12',
 333       'maxlength' => '60',
 334     ],
 335     'default' => '%m/%d/%Y',
 336     'title' => ts('Date Format: Short date Month Day Year'),
 337   ],
 338   'dateInputFormat' => [
 339     'add' => '4.7',
 340     'help_text' => NULL,
 341     'is_domain' => 1,
 342     'is_contact' => 0,
 343     'group_name' => 'Localization Preferences',
 344     'group' => 'localization',
 345     'name' => 'dateInputFormat',
 346     'type' => 'String',
 347     'quick_form_type' => 'Select',
 348     'html_type' => 'Select',
 349     'pseudoconstant' => [
 350       'callback' => 'CRM_Core_SelectValues::getDatePluginInputFormats',
 351     ],
 352     'default' => 'mm/dd/yy',
 353     'title' => ts('Date Input Format'),
 354   ],
 355   'fieldSeparator' => [
 356     'add' => '4.7',
 357     'help_text' => NULL,
 358     'is_domain' => 1,
 359     'is_contact' => 0,
 360     'group_name' => 'Localization Preferences',
 361     'group' => 'localization',
 362     'name' => 'fieldSeparator',
 363     'type' => 'String',
 364     'quick_form_type' => 'Element',
 365     'html_type' => 'text',
 366     'html_attributes' => [
 367       'size' => '2',
 368       'maxlength' => '8',
 369     ],
 370     'default' => ',',
 371     'title' => ts('Import / Export Field Separator'),
 372     'description' => ts('Global CSV separator character. Modify this setting to enable import and export of different kinds of CSV files (for example: \',\' \';\' \':\' \'|\' ).'),
 373   ],
 374   'fiscalYearStart' => [
 375     'add' => '4.7',
 376     'help_text' => NULL,
 377     'is_domain' => 1,
 378     'is_contact' => 0,
 379     'group_name' => 'Localization Preferences',
 380     'group' => 'localization',
 381     'name' => 'fiscalYearStart',
 382     'type' => 'Array',
 383     'quick_form_type' => 'MonthDay',
 384     'html_type' => 'MonthDay',
 385     'default' => ['M' => 1, 'd' => 1],
 386     'title' => ts('Fiscal Year Start'),
 387   ],
 388   'languageLimit' => [
 389     'group_name' => 'Localization Preferences',
 390     'group' => 'localization',
 391     'name' => 'languageLimit',
 392     'type' => 'Array',
 393     'quick_form_type' => 'Select',
 394     'html_type' => 'Select',
 395     'html_attributes' => [
 396       'multiple' => 1,
 397       'class' => 'crm-select2',
 398     ],
 399     'default' => NULL,
 400     'add' => '4.3',
 401     'title' => ts('Available Languages (Multi-lingual)'),
 402     'is_domain' => 1,
 403     'is_contact' => 0,
 404     'help_text' => NULL,
 405     'pseudoconstant' => [
 406       'callback' => 'CRM_Core_I18n::languages',
 407     ],
 408   ],
 409   'uiLanguages' => [
 410     'group_name' => 'Localization Preferences',
 411     'group' => 'localization',
 412     'name' => 'uiLanguages',
 413     'type' => 'Array',
 414     'quick_form_type' => 'Select',
 415     'html_type' => 'select',
 416     'html_attributes' => [
 417       'multiple' => 1,
 418       'class' => 'crm-select2',
 419     ],
 420     'default' => NULL,
 421     'add' => '5.9',
 422     'title' => ts('Available Languages'),
 423     'is_domain' => 1,
 424     'is_contact' => 0,
 425     'help_text' => ts('User Interface languages available to users'),
 426     'pseudoconstant' => [
 427       'callback' => 'CRM_Core_I18n::languages',
 428     ],
 429   ],
 430   'lcMessages' => [
 431     'group_name' => 'Localization Preferences',
 432     'group' => 'localization',
 433     'name' => 'lcMessages',
 434     'type' => 'String',
 435     'quick_form_type' => 'Select',
 436     'html_type' => 'Select',
 437     'html_attributes' => [
 438       'class' => 'crm-select2',
 439     ],
 440     'default' => 'en_US',
 441     'add' => '4.3',
 442     'title' => ts('Default Language'),
 443     'is_domain' => 1,
 444     'is_contact' => 0,
 445     'help_text' => NULL,
 446     'pseudoconstant' => [
 447       'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLocaleOptions',
 448     ],
 449     'on_change' => [
 450       'CRM_Admin_Form_Setting_Localization::onChangeLcMessages',
 451     ],
 452   ],
 453   'legacyEncoding' => [
 454     'add' => '4.7',
 455     'help_text' => NULL,
 456     'is_domain' => 1,
 457     'is_contact' => 0,
 458     'group_name' => 'Localization Preferences',
 459     'group' => 'localization',
 460     'name' => 'legacyEncoding',
 461     'type' => 'String',
 462     'quick_form_type' => 'Element',
 463     'html_type' => 'text',
 464     'html_attributes' => [
 465       'size' => '12',
 466       'maxlength' => '30',
 467     ],
 468     'default' => 'Windows-1252',
 469     'title' => ts('Legacy Encoding'),
 470     '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.'),
 471   ],
 472   'timeInputFormat' => [
 473     'add' => '4.7',
 474     'help_text' => NULL,
 475     'is_domain' => 1,
 476     'is_contact' => 0,
 477     'group_name' => 'Localization Preferences',
 478     'group' => 'localization',
 479     'name' => 'timeInputFormat',
 480     'type' => 'String',
 481     'quick_form_type' => 'Select',
 482     'html_type' => 'Select',
 483     'pseudoconstant' => [
 484       'callback' => 'CRM_Core_SelectValues::getTimeFormats',
 485     ],
 486     'default' => '1',
 487     'title' => ts('Time Input Format'),
 488     'on_change' => [
 489       'CRM_Core_BAO_PreferencesDate::onChangeSetting',
 490     ],
 491   ],
 492   'weekBegins' => [
 493     'group_name' => 'Localization Preferences',
 494     'group' => 'localization',
 495     'name' => 'weekBegins',
 496     'type' => 'String',
 497     'quick_form_type' => 'Select',
 498     'html_type' => 'Select',
 499     'pseudoconstant' => [
 500       'callback' => 'CRM_Utils_Date::getFullWeekdayNames',
 501     ],
 502     'default' => '0',
 503     'add' => '4.7',
 504     'title' => ts('Week begins on'),
 505     'is_domain' => 1,
 506     'is_contact' => 0,
 507     'help_text' => NULL,
 508   ],
 509   'contact_default_language' => [
 510     'group_name' => 'Localization Preferences',
 511     'group' => 'localization',
 512     'name' => 'contact_default_language',
 513     'type' => 'String',
 514     'quick_form_type' => 'Select',
 515     'html_type' => 'Select',
 516     'html_attributes' => [
 517       'class' => 'crm-select2',
 518     ],
 519     'pseudoconstant' => [
 520       'callback' => 'CRM_Admin_Form_Setting_Localization::getDefaultLanguageOptions',
 521     ],
 522     'default' => '*default*',
 523     'add' => '4.7',
 524     'title' => ts('Default Language for contacts'),
 525     'is_domain' => 1,
 526     'is_contact' => 0,
 527     'description' => ts('Default language (if any) for contact records.'),
 528     'help_text' => 'If a contact is created with no language this setting will determine the language data (if any) to save.'
 529     . 'You may or may not wish to make an assumption here about whether it matches the site language',
 530   ],
 531   'pinnedContactCountries' => [
 532     'group_name' => 'Localization Preferences',
 533     'group' => 'localization',
 534     'name' => 'pinnedContactCountries',
 535     'type' => 'Array',
 536     'quick_form_type' => 'Element',
 537     'html_type' => 'advmultiselect',
 538     'html_attributes' => [
 539       'size' => 5,
 540       'style' => 'width:150px',
 541       'class' => 'advmultiselect',
 542     ],
 543     'default' => [],
 544     'add' => '5.33',
 545     'title' => ts('Pinned Countries'),
 546     'is_domain' => 1,
 547     'is_contact' => 0,
 548     'description' => ts('Appear in Top section of select list'),
 549     'help_text' => ts('Selected countries will appear in top section of country list'),
 550     'pseudoconstant' => [
 551       'callback' => 'CRM_Admin_Form_Setting_Localization::getAvailableCountries',
 552     ],
 553   ],
 554 ];