3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
35 * This class generates form components for Localization.
37 class CRM_Admin_Form_Setting_Localization
extends CRM_Admin_Form_Setting
{
39 protected $_settings = array(
40 'contact_default_language' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
41 'countryLimit' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
42 'customTranslateFunction' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
43 'defaultContactCountry' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
44 'defaultContactStateProvince' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
45 'defaultCurrency' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
46 'fieldSeparator' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
47 'inheritLocale' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
48 'lcMessages' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
49 'legacyEncoding' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
50 'monetaryThousandSeparator' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
51 'monetaryDecimalPoint' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
52 'moneyformat' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
53 'moneyvalueformat' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
54 'provinceLimit' => CRM_Core_BAO_Setting
::LOCALIZATION_PREFERENCES_NAME
,
58 * Build the form object.
60 public function buildQuickForm() {
61 $config = CRM_Core_Config
::singleton();
63 CRM_Utils_System
::setTitle(ts('Settings - Localization'));
65 $warningTitle = json_encode(ts("Warning"));
66 $defaultLocaleOptions = CRM_Admin_Form_Setting_Localization
::getDefaultLocaleOptions();
68 $domain = new CRM_Core_DAO_Domain();
71 if ($domain->locales
) {
72 // add language limiter and language adder
73 $this->addCheckBox('languageLimit', ts('Available Languages'), array_flip($defaultLocaleOptions), NULL, NULL, NULL, NULL, ' ');
74 $this->addElement('select', 'addLanguage', ts('Add Language'), array_merge(array('' => ts('- select -')), array_diff(CRM_Core_I18n
::languages(), $defaultLocaleOptions)));
76 // add the ability to return to single language
77 $warning = ts('This will make your CiviCRM installation a single-language one again. THIS WILL DELETE ALL DATA RELATED TO LANGUAGES OTHER THAN THE DEFAULT ONE SELECTED ABOVE (and only that language will be preserved).');
78 $this->assign('warning', $warning);
79 $warning = json_encode($warning);
80 $this->addElement('checkbox', 'makeSinglelingual', ts('Return to Single Language'),
81 NULL, array('onChange' => "if (this.checked) CRM.alert($warning, $warningTitle)")
85 $warning = ts('Enabling multiple languages changes the schema of your database, so make sure you know what you are doing when enabling this function; making a database backup is strongly recommended.');
86 $this->assign('warning', $warning);
87 $warning = json_encode($warning);
88 $validTriggerPermission = CRM_Core_DAO
::checkTriggerViewPermission(TRUE);
90 if ($validTriggerPermission &&
91 !\Civi
::settings()->get('logging')
93 $this->addElement('checkbox', 'makeMultilingual', ts('Enable Multiple Languages'),
94 NULL, array('onChange' => "if (this.checked) CRM.alert($warning, $warningTitle)")
98 $this->addElement('select', 'contact_default_language', ts('Default Language for users'),
99 CRM_Admin_Form_Setting_Localization
::getDefaultLanguageOptions());
101 $includeCurrency = &$this->addElement('advmultiselect', 'currencyLimit',
102 ts('Available Currencies') . ' ', self
::getCurrencySymbols(),
105 'style' => 'width:150px',
106 'class' => 'advmultiselect',
110 $includeCurrency->setButtonAttributes('add', array('value' => ts('Add >>')));
111 $includeCurrency->setButtonAttributes('remove', array('value' => ts('<< Remove')));
113 $this->addFormRule(array('CRM_Admin_Form_Setting_Localization', 'formRule'));
115 parent
::buildQuickForm();
123 public static function formRule($fields) {
125 if (CRM_Utils_Array
::value('monetaryThousandSeparator', $fields) ==
126 CRM_Utils_Array
::value('monetaryDecimalPoint', $fields)
128 $errors['monetaryThousandSeparator'] = ts('Thousands Separator and Decimal Delimiter can not be the same.');
131 if (strlen($fields['monetaryThousandSeparator']) == 0) {
132 $errors['monetaryThousandSeparator'] = ts('Thousands Separator can not be empty. You can use a space character instead.');
135 if (strlen($fields['monetaryThousandSeparator']) > 1) {
136 $errors['monetaryThousandSeparator'] = ts('Thousands Separator can not have more than 1 character.');
139 if (strlen($fields['monetaryDecimalPoint']) > 1) {
140 $errors['monetaryDecimalPoint'] = ts('Decimal Delimiter can not have more than 1 character.');
143 if (trim($fields['customTranslateFunction']) &&
144 !function_exists(trim($fields['customTranslateFunction']))
146 $errors['customTranslateFunction'] = ts('Please define the custom translation function first.');
149 // CRM-7962, CRM-7713, CRM-9004
150 if (!empty($fields['defaultContactCountry']) &&
151 (!empty($fields['countryLimit']) &&
152 (!in_array($fields['defaultContactCountry'], $fields['countryLimit']))
155 $errors['defaultContactCountry'] = ts('Please select a default country that is in the list of available countries.');
158 return empty($errors) ?
TRUE : $errors;
162 * Set the default values for the form.
166 public function setDefaultValues() {
167 parent
::setDefaultValues();
170 // retrieve default values for currencyLimit
171 $this->_defaults
['currencyLimit'] = array_keys(CRM_Core_OptionGroup
::values('currencies_enabled'));
173 $this->_defaults
['languageLimit'] = Civi
::settings()->get('languageLimit');
175 // CRM-5111: unset these two unconditionally, we don’t want them to stick – ever
176 unset($this->_defaults
['makeMultilingual']);
177 unset($this->_defaults
['makeSinglelingual']);
178 return $this->_defaults
;
181 public function postProcess() {
182 $values = $this->exportValues();
184 //cache contact fields retaining localized titles
185 //though we changed localization, so reseting cache.
186 CRM_Core_BAO_Cache
::deleteGroup('contact fields');
188 //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
189 CRM_Core_BAO_Cache
::deleteGroup('navigation');
191 // we do this only to initialize monetary decimal point and thousand separator
192 $config = CRM_Core_Config
::singleton();
194 // save enabled currencies and default currency in option group 'currencies_enabled'
196 if (empty($values['currencyLimit'])) {
197 $values['currencyLimit'] = array($values['defaultCurrency']);
199 elseif (!in_array($values['defaultCurrency'], $values['currencyLimit'])) {
200 $values['currencyLimit'][] = $values['defaultCurrency'];
203 self
::updateEnabledCurrencies($values['currencyLimit'], $values['defaultCurrency']);
205 // unset currencyLimit so we dont store there
206 unset($values['currencyLimit']);
208 // make the site multi-lang if requested
209 if (!empty($values['makeMultilingual'])) {
210 CRM_Core_I18n_Schema
::makeMultilingual($values['lcMessages']);
211 $values['languageLimit'][$values['lcMessages']] = 1;
212 // make the site single-lang if requested
214 elseif (!empty($values['makeSinglelingual'])) {
215 CRM_Core_I18n_Schema
::makeSinglelingual($values['lcMessages']);
216 $values['languageLimit'] = '';
219 // add a new db locale if the requested language is not yet supported by the db
220 if (!CRM_Utils_Array
::value('makeSinglelingual', $values) and CRM_Utils_Array
::value('addLanguage', $values)) {
221 $domain = new CRM_Core_DAO_Domain();
223 if (!substr_count($domain->locales
, $values['addLanguage'])) {
224 CRM_Core_I18n_Schema
::addLocale($values['addLanguage'], $values['lcMessages']);
226 $values['languageLimit'][$values['addLanguage']] = 1;
229 // if we manipulated the language list, return to the localization admin screen
230 $return = (bool) (CRM_Utils_Array
::value('makeMultilingual', $values) or CRM_Utils_Array
::value('addLanguage', $values));
232 $filteredValues = $values;
233 unset($filteredValues['makeMultilingual']);
234 unset($filteredValues['makeSinglelingual']);
235 unset($filteredValues['addLanguage']);
236 unset($filteredValues['languageLimit']);
238 Civi
::settings()->set('languageLimit', CRM_Utils_Array
::value('languageLimit', $values));
240 // save all the settings
241 parent
::commonProcess($filteredValues);
244 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/setting/localization', 'reset=1'));
250 * Replace available currencies by the ones provided
252 * @param $currencies array of currencies ['USD', 'CAD']
253 * @param $default default currency
255 public static function updateEnabledCurrencies($currencies, $default) {
257 // sort so that when we display drop down, weights have right value
260 // get labels for all the currencies
263 $currencySymbols = CRM_Admin_Form_Setting_Localization
::getCurrencySymbols();
264 for ($i = 0; $i < count($currencies); $i++
) {
266 'label' => $currencySymbols[$currencies[$i]],
267 'value' => $currencies[$i],
270 'is_default' => $currencies[$i] == $default,
275 CRM_Core_OptionGroup
::createAssoc('currencies_enabled', $options, $dontCare);
283 public static function getAvailableCountries() {
284 $i18n = CRM_Core_I18n
::singleton();
286 CRM_Core_PseudoConstant
::populate($country, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active');
287 $i18n->localizeArray($country, array('context' => 'country'));
293 * Get the default locale options.
297 public static function getDefaultLocaleOptions() {
298 $domain = new CRM_Core_DAO_Domain();
300 $locales = CRM_Core_I18n
::languages();
301 if ($domain->locales
) {
302 // for multi-lingual sites, populate default language drop-down with available languages
303 $defaultLocaleOptions = array();
304 foreach ($locales as $loc => $lang) {
305 if (substr_count($domain->locales
, $loc)) {
306 $defaultLocaleOptions[$loc] = $lang;
311 $defaultLocaleOptions = $locales;
313 return $defaultLocaleOptions;
317 * Get a list of currencies (with their symbols).
320 * Array('USD' => 'USD ($)').
322 public static function getCurrencySymbols() {
323 $symbols = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', array(
324 'labelColumn' => 'symbol',
325 'orderColumn' => TRUE,
327 $_currencySymbols = array();
328 foreach ($symbols as $key => $value) {
329 $_currencySymbols[$key] = "$key";
331 $_currencySymbols[$key] .= " ($value)";
334 return $_currencySymbols;
338 * Update session and uf_match table when the locale is updated.
340 * @param string $oldLocale
341 * @param string $newLocale
342 * @param array $metadata
343 * @param int $domainID
345 public static function onChangeLcMessages($oldLocale, $newLocale, $metadata, $domainID) {
346 if ($oldLocale == $newLocale) {
350 $session = CRM_Core_Session
::singleton();
351 if ($newLocale && $session->get('userID')) {
352 $ufm = new CRM_Core_DAO_UFMatch();
353 $ufm->contact_id
= $session->get('userID');
354 if ($newLocale && $ufm->find(TRUE)) {
355 $ufm->language
= $newLocale;
357 $session->set('lcMessages', $newLocale);
362 public static function onChangeDefaultCurrency($oldCurrency, $newCurrency, $metadata) {
363 if ($oldCurrency == $newCurrency) {
367 // ensure that default currency is always in the list of enabled currencies
368 $currencies = array_keys(CRM_Core_OptionGroup
::values('currencies_enabled'));
369 if (!in_array($newCurrency, $currencies)) {
370 if (empty($currencies)) {
371 $currencies = array($values['defaultCurrency']);
374 $currencies[] = $newCurrency;
377 CRM_Admin_Form_Setting_Localization
::updateEnabledCurrencies($currencies, $newCurrency);
385 public static function getDefaultLanguageOptions() {
387 '*default*' => ts('Use default site language'),
388 'undefined' => ts('Leave undefined'),
389 'current_site_language' => ts('Use language in use at the time'),