3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * This class generates form components for Localization
40 class CRM_Admin_Form_Setting_Localization
extends CRM_Admin_Form_Setting
{
41 // use this variable to store mappings that we compute in buildForm and also
42 // use in postProcess (CRM-1496)
43 protected $_currencySymbols;
46 * Function to build the form
51 public function buildQuickForm() {
52 $config = CRM_Core_Config
::singleton();
54 $i18n = CRM_Core_I18n
::singleton();
55 CRM_Utils_System
::setTitle(ts('Settings - Localization'));
57 $locales = CRM_Core_I18n
::languages();
58 $warningTitle = json_encode(ts("Warning"));
59 $domain = new CRM_Core_DAO_Domain();
61 if ($domain->locales
) {
62 // for multi-lingual sites, populate default language drop-down with available languages
63 $lcMessages = array();
64 foreach ($locales as $loc => $lang) {
65 if (substr_count($domain->locales
, $loc)) {
66 $lcMessages[$loc] = $lang;
69 $this->addElement('select', 'lcMessages', ts('Default Language'), $lcMessages);
71 // add language limiter and language adder
72 $this->addCheckBox('languageLimit', ts('Available Languages'), array_flip($lcMessages), NULL, NULL, NULL, NULL, ' ');
73 $this->addElement('select', 'addLanguage', ts('Add Language'), array_merge(array('' => ts('- select -')), array_diff($locales, $lcMessages)));
75 // add the ability to return to single language
76 $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).');
77 $this->assign('warning', $warning);
78 $warning = json_encode($warning);
79 $this->addElement('checkbox', 'makeSinglelingual', ts('Return to Single Language'),
80 NULL, array('onChange' => "if (this.checked) CRM.alert($warning, $warningTitle)")
84 // for single-lingual sites, populate default language drop-down with all languages
85 $this->addElement('select', 'lcMessages', ts('Default Language'), $locales);
87 $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.');
88 $this->assign('warning', $warning);
89 $warning = json_encode($warning);
90 $validTriggerPermission = CRM_Core_DAO
::checkTriggerViewPermission(TRUE);
92 if ($validTriggerPermission &&
95 $this->addElement('checkbox', 'makeMultilingual', ts('Enable Multiple Languages'),
96 NULL, array('onChange' => "if (this.checked) CRM.alert($warning, $warningTitle)")
101 $this->addElement('checkbox', 'inheritLocale', ts('Inherit CMS Language'));
102 $this->addElement('text', 'monetaryThousandSeparator', ts('Thousands Separator'), array('size' => 2));
103 $this->addElement('text', 'monetaryDecimalPoint', ts('Decimal Delimiter'), array('size' => 2));
104 $this->addElement('text', 'moneyformat', ts('Monetary Amount Display'));
105 $this->addElement('text', 'moneyvalueformat', ts('Monetary Value Display'));
108 CRM_Core_PseudoConstant
::populate($country, 'CRM_Core_DAO_Country', TRUE, 'name', 'is_active');
109 $i18n->localizeArray($country, array('context' => 'country'));
112 $includeCountry = &$this->addElement('advmultiselect', 'countryLimit',
113 ts('Available Countries') . ' ', $country,
116 'style' => 'width:150px',
117 'class' => 'advmultiselect',
121 $includeCountry->setButtonAttributes('add', array('value' => ts('Add >>')));
122 $includeCountry->setButtonAttributes('remove', array('value' => ts('<< Remove')));
124 $includeState = &$this->addElement('advmultiselect', 'provinceLimit',
125 ts('Available States and Provinces') . ' ', $country,
128 'style' => 'width:150px',
129 'class' => 'advmultiselect',
133 $includeState->setButtonAttributes('add', array('value' => ts('Add >>')));
134 $includeState->setButtonAttributes('remove', array('value' => ts('<< Remove')));
136 $this->addElement('select', 'defaultContactCountry', ts('Default Country'), array('' => ts('- select -')) +
$country);
138 /***Default State/Province***/
139 $stateCountryMap = array();
140 $stateCountryMap[] = array(
141 'state_province' => 'defaultContactStateProvince',
142 'country' => 'defaultContactCountry',
145 $countryDefault = isset($this->_submitValues
['defaultContactCountry']) ?
$this->_submitValues
['defaultContactCountry'] : $config->defaultContactCountry
;
147 if ($countryDefault) {
148 $selectStateProvinceOptions = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::stateProvinceForCountry($countryDefault);
151 $selectStateProvinceOptions = array('' => ts('- select a country -'));
154 $i18n->localizeArray($selectStateProvinceOptions, array('context' => 'state_province'));
155 asort($selectStateProvinceOptions);
157 $this->addElement('select', 'defaultContactStateProvince', ts('Default State/Province'), $selectStateProvinceOptions);
160 CRM_Core_BAO_Address
::addStateCountryMap($stateCountryMap);
163 CRM_Core_BAO_Address
::fixAllStateSelects($form, $defaults);
165 // we do this only to initialize currencySymbols, kinda hackish but works!
166 $config->defaultCurrencySymbol();
168 $symbol = $config->currencySymbols
;
169 foreach ($symbol as $key => $value) {
170 $this->_currencySymbols
[$key] = "$key";
172 $this->_currencySymbols
[$key] .= " ($value)";
175 $this->addElement('select', 'defaultCurrency', ts('Default Currency'), $this->_currencySymbols
);
177 $includeCurrency = &$this->addElement('advmultiselect', 'currencyLimit',
178 ts('Available Currencies') . ' ', $this->_currencySymbols
,
181 'style' => 'width:150px',
182 'class' => 'advmultiselect',
186 $includeCurrency->setButtonAttributes('add', array('value' => ts('Add >>')));
187 $includeCurrency->setButtonAttributes('remove', array('value' => ts('<< Remove')));
189 $this->addElement('text', 'legacyEncoding', ts('Legacy Encoding'));
190 $this->addElement('text', 'customTranslateFunction', ts('Custom Translate Function'));
191 $this->addElement('text', 'fieldSeparator', ts('Import / Export Field Separator'), array('size' => 2));
193 $this->addFormRule(array('CRM_Admin_Form_Setting_Localization', 'formRule'));
195 parent
::buildQuickForm();
198 static function formRule($fields) {
200 if (CRM_Utils_Array
::value('monetaryThousandSeparator', $fields) ==
201 CRM_Utils_Array
::value('monetaryDecimalPoint', $fields)
203 $errors['monetaryThousandSeparator'] = ts('Thousands Separator and Decimal Delimiter can not be the same.');
206 if (strlen($fields['monetaryThousandSeparator']) == 0) {
207 $errors['monetaryThousandSeparator'] = ts('Thousands Separator can not be empty. You can use a space character instead.');
210 if (strlen($fields['monetaryThousandSeparator']) > 1) {
211 $errors['monetaryThousandSeparator'] = ts('Thousands Separator can not have more than 1 character.');
214 if (strlen($fields['monetaryDecimalPoint']) > 1) {
215 $errors['monetaryDecimalPoint'] = ts('Decimal Delimiter can not have more than 1 character.');
218 if (trim($fields['customTranslateFunction']) &&
219 !function_exists(trim($fields['customTranslateFunction']))
221 $errors['customTranslateFunction'] = ts('Please define the custom translation function first.');
224 // CRM-7962, CRM-7713, CRM-9004
225 if (!empty($fields['defaultContactCountry']) &&
226 (CRM_Utils_Array
::value('countryLimit', $fields) &&
227 (!in_array($fields['defaultContactCountry'], $fields['countryLimit']))
230 $errors['defaultContactCountry'] = ts('Please select a default country that is in the list of available countries.');
233 return empty($errors) ?
TRUE : $errors;
236 function setDefaultValues() {
237 parent
::setDefaultValues();
240 // retrieve default values for currencyLimit
241 $this->_defaults
['currencyLimit'] = array_keys(CRM_Core_OptionGroup
::values('currencies_enabled'));
243 // CRM-5111: unset these two unconditionally, we don’t want them to stick – ever
244 unset($this->_defaults
['makeMultilingual']);
245 unset($this->_defaults
['makeSinglelingual']);
246 return $this->_defaults
;
249 public function postProcess() {
250 $values = $this->exportValues();
252 // FIXME: stupid QF not submitting unchecked checkboxen…
253 if (!isset($values['inheritLocale'])) {
254 $values['inheritLocale'] = 0;
257 //cache contact fields retaining localized titles
258 //though we changed localization, so reseting cache.
259 CRM_Core_BAO_Cache
::deleteGroup('contact fields');
261 //CRM-8559, cache navigation do not respect locale if it is changed, so reseting cache.
262 CRM_Core_BAO_Cache
::deleteGroup('navigation');
264 // we do this only to initialize monetary decimal point and thousand separator
265 $config = CRM_Core_Config
::singleton();
267 // set default Currency Symbol
268 $values['defaultCurrencySymbol'] = $config->defaultCurrencySymbol($values['defaultCurrency']);
270 // save enabled currencies and defaul currency in option group 'currencies_enabled'
272 if (empty($values['currencyLimit'])) {
273 $values['currencyLimit'] = array($values['defaultCurrency']);
275 elseif (!in_array($values['defaultCurrency'],
276 $values['currencyLimit']
278 $values['currencyLimit'][] = $values['defaultCurrency'];
281 // sort so that when we display drop down, weights have right value
282 sort($values['currencyLimit']);
284 // get labels for all the currencies
287 for ($i = 0; $i < count($values['currencyLimit']); $i++
) {
289 'label' => $this->_currencySymbols
[$values['currencyLimit'][$i]],
290 'value' => $values['currencyLimit'][$i],
293 'is_default' => $values['currencyLimit'][$i] == $values['defaultCurrency'],
298 CRM_Core_OptionGroup
::createAssoc('currencies_enabled',
303 // unset currencyLimit so we dont store there
304 unset($values['currencyLimit']);
306 // make the site multi-lang if requested
307 if (CRM_Utils_Array
::value('makeMultilingual', $values)) {
308 CRM_Core_I18n_Schema
::makeMultilingual($values['lcMessages']);
309 $values['languageLimit'][$values['lcMessages']] = 1;
310 // make the site single-lang if requested
312 elseif (CRM_Utils_Array
::value('makeSinglelingual', $values)) {
313 CRM_Core_I18n_Schema
::makeSinglelingual($values['lcMessages']);
314 $values['languageLimit'] = '';
317 // add a new db locale if the requested language is not yet supported by the db
318 if (!CRM_Utils_Array
::value('makeSinglelingual', $values) and CRM_Utils_Array
::value('addLanguage', $values)) {
319 $domain = new CRM_Core_DAO_Domain();
321 if (!substr_count($domain->locales
, $values['addLanguage'])) {
322 CRM_Core_I18n_Schema
::addLocale($values['addLanguage'], $values['lcMessages']);
324 $values['languageLimit'][$values['addLanguage']] = 1;
327 // if we manipulated the language list, return to the localization admin screen
328 $return = (bool)(CRM_Utils_Array
::value('makeMultilingual', $values) or CRM_Utils_Array
::value('addLanguage', $values));
330 // save all the settings
331 parent
::commonProcess($values);
334 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/setting/localization', 'reset=1'));