3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
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 &&
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;
161 public function setDefaultValues() {
162 parent
::setDefaultValues();
165 // retrieve default values for currencyLimit
166 $this->_defaults
['currencyLimit'] = array_keys(CRM_Core_OptionGroup
::values('currencies_enabled'));
168 $this->_defaults
['languageLimit'] = Civi
::settings()->get('languageLimit');
170 // CRM-5111: unset these two unconditionally, we don’t want them to stick – ever
171 unset($this->_defaults
['makeMultilingual']);
172 unset($this->_defaults
['makeSinglelingual']);
173 return $this->_defaults
;
176 public function postProcess() {
177 $values = $this->exportValues();
179 //cache contact fields retaining localized titles
180 //though we changed localization, so reseting cache.
181 CRM_Core_BAO_Cache
::deleteGroup('contact fields');
183 //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
184 CRM_Core_BAO_Cache
::deleteGroup('navigation');
186 // we do this only to initialize monetary decimal point and thousand separator
187 $config = CRM_Core_Config
::singleton();
189 // save enabled currencies and defaul currency in option group 'currencies_enabled'
191 if (empty($values['currencyLimit'])) {
192 $values['currencyLimit'] = array($values['defaultCurrency']);
194 elseif (!in_array($values['defaultCurrency'],
195 $values['currencyLimit']
198 $values['currencyLimit'][] = $values['defaultCurrency'];
201 // sort so that when we display drop down, weights have right value
202 sort($values['currencyLimit']);
204 // get labels for all the currencies
207 $currencySymbols = self
::getCurrencySymbols();
208 for ($i = 0; $i < count($values['currencyLimit']); $i++
) {
210 'label' => $currencySymbols[$values['currencyLimit'][$i]],
211 'value' => $values['currencyLimit'][$i],
214 'is_default' => $values['currencyLimit'][$i] == $values['defaultCurrency'],
219 CRM_Core_OptionGroup
::createAssoc('currencies_enabled',
224 // unset currencyLimit so we dont store there
225 unset($values['currencyLimit']);
227 // make the site multi-lang if requested
228 if (!empty($values['makeMultilingual'])) {
229 CRM_Core_I18n_Schema
::makeMultilingual($values['lcMessages']);
230 $values['languageLimit'][$values['lcMessages']] = 1;
231 // make the site single-lang if requested
233 elseif (!empty($values['makeSinglelingual'])) {
234 CRM_Core_I18n_Schema
::makeSinglelingual($values['lcMessages']);
235 $values['languageLimit'] = '';
238 // add a new db locale if the requested language is not yet supported by the db
239 if (!CRM_Utils_Array
::value('makeSinglelingual', $values) and CRM_Utils_Array
::value('addLanguage', $values)) {
240 $domain = new CRM_Core_DAO_Domain();
242 if (!substr_count($domain->locales
, $values['addLanguage'])) {
243 CRM_Core_I18n_Schema
::addLocale($values['addLanguage'], $values['lcMessages']);
245 $values['languageLimit'][$values['addLanguage']] = 1;
248 // if we manipulated the language list, return to the localization admin screen
249 $return = (bool) (CRM_Utils_Array
::value('makeMultilingual', $values) or CRM_Utils_Array
::value('addLanguage', $values));
251 $filteredValues = $values;
252 unset($filteredValues['makeMultilingual']);
253 unset($filteredValues['makeSinglelingual']);
254 unset($filteredValues['addLanguage']);
255 unset($filteredValues['languageLimit']);
257 Civi
::settings()->set('languageLimit', CRM_Utils_Array
::value('languageLimit', $values));
259 // save all the settings
260 parent
::commonProcess($filteredValues);
263 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/setting/localization', 'reset=1'));
270 public static function getAvailableCountries() {
271 $i18n = CRM_Core_I18n
::singleton();
273 CRM_Core_PseudoConstant
::populate($country, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active');
274 $i18n->localizeArray($country, array('context' => 'country'));
282 public static function getDefaultLocaleOptions() {
283 $domain = new CRM_Core_DAO_Domain();
285 $locales = CRM_Core_I18n
::languages();
286 if ($domain->locales
) {
287 // for multi-lingual sites, populate default language drop-down with available languages
288 $defaultLocaleOptions = array();
289 foreach ($locales as $loc => $lang) {
290 if (substr_count($domain->locales
, $loc)) {
291 $defaultLocaleOptions[$loc] = $lang;
296 $defaultLocaleOptions = $locales;
298 return $defaultLocaleOptions;
302 * Get a list of currencies (with their symbols).
305 * Array('USD' => 'USD ($)').
307 public static function getCurrencySymbols() {
308 $symbols = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'currency', array(
309 'labelColumn' => 'symbol',
310 'orderColumn' => TRUE,
312 $_currencySymbols = array();
313 foreach ($symbols as $key => $value) {
314 $_currencySymbols[$key] = "$key";
316 $_currencySymbols[$key] .= " ($value)";
319 return $_currencySymbols;
322 public static function onChangeLcMessages($oldLocale, $newLocale, $metadata, $domainID) {
323 if ($oldLocale == $newLocale) {
327 $session = CRM_Core_Session
::singleton();
328 if ($newLocale && $session->get('userID')) {
329 $ufm = new CRM_Core_DAO_UFMatch();
330 $ufm->contact_id
= $session->get('userID');
331 if ($newLocale && $ufm->find(TRUE)) {
332 $ufm->language
= $newLocale;
334 $session->set('lcMessages', $newLocale);
342 public static function getDefaultLanguageOptions() {
344 '*default*' => ts('Use default site language'),
345 'undefined' => ts('Leave undefined'),
346 'current_site_language' => ts('Use language in use at the time'),