settings/Localization.setting.php

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