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