3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Admin_Form_WordReplacements
extends CRM_Core_Form
{
36 protected $_numStrings = 10;
38 protected $_stringName = NULL;
40 protected $_defaults = NULL;
42 function preProcess() {
43 // This controller was originally written to CRUD $config->locale_custom_strings,
44 // but that's no longer the canonical store. Re-sync from canonical store to ensure
45 // that we display that latest data. This is inefficient - at some point, we
46 // should rewrite this UI.
47 CRM_Core_BAO_WordReplacement
::rebuild(FALSE);
49 $this->_soInstance
= CRM_Utils_Array
::value('instance', $_GET);
50 $this->assign('soInstance', $this->_soInstance
);
51 $breadCrumbUrl = CRM_Utils_System
::url('civicrm/admin/options/wordreplacements',
54 $breadCrumb = array(array('title' => ts('Word Replacements'),
55 'url' => $breadCrumbUrl,
57 CRM_Utils_System
::appendBreadCrumb($breadCrumb);
63 public function setDefaultValues() {
64 if ($this->_defaults
!== NULL) {
65 return $this->_defaults
;
68 $this->_defaults
= array();
70 $config = CRM_Core_Config
::singleton();
72 $values = $config->localeCustomStrings
[$config->lcMessages
];
75 $enableDisable = array(
80 $cardMatch = array('wildcardMatch', 'exactMatch');
82 foreach ($enableDisable as $key => $val) {
83 foreach ($cardMatch as $kc => $vc) {
84 if (!empty($values[$val][$vc])) {
85 foreach ($values[$val][$vc] as $k => $v) {
86 $this->_defaults
["enabled"][$i] = $key;
87 $this->_defaults
["cb"][$i] = $kc;
88 $this->_defaults
["old"][$i] = $k;
89 $this->_defaults
["new"][$i] = $v;
96 $name = $this->_stringName
= "custom_string_override_{$config->lcMessages}";
97 if (isset($config->$name) &&
98 is_array($config->$name)
100 $this->_numStrings
= 1;
101 foreach ($config->$name as $old => $newValues) {
102 $this->_numStrings++
;
103 $this->_numStrings +
= 9;
107 $this->_numStrings
= 10;
110 return $this->_defaults
;
114 * Function to actually build the form
119 public function buildQuickForm() {
120 $config = CRM_Core_Config
::singleton();
121 $values = $config->localeCustomStrings
[$config->lcMessages
];
125 foreach ( $values as $valMatchType ) {
126 foreach ( $valMatchType as $valPairs ) {
127 $instances +
= count($valPairs);
131 if ($instances > 10) {
132 $this->_numStrings
= $instances;
135 $soInstances = range(1, $this->_numStrings
, 1);
136 $stringOverrideInstances = array();
137 if ($this->_soInstance
) {
138 $soInstances = array($this->_soInstance
);
140 elseif (!empty($_POST['old'])) {
141 $soInstances = $stringOverrideInstances = array_keys($_POST['old']);
143 elseif (!empty($this->_defaults
) && is_array($this->_defaults
)) {
144 $stringOverrideInstances = array_keys($this->_defaults
['new']);
145 if (count($this->_defaults
['old']) > count($this->_defaults
['new'])) {
146 $stringOverrideInstances = array_keys($this->_defaults
['old']);
149 foreach ($soInstances as $instance) {
150 $this->addElement('checkbox', "enabled[$instance]");
151 $this->add('textarea', "old[$instance]", NULL, array('rows' => 1, 'cols' => 40));
152 $this->add('textarea', "new[$instance]", NULL, array('rows' => 1, 'cols' => 40));
153 $this->addElement('checkbox', "cb[$instance]");
155 $this->assign('numStrings', $this->_numStrings
);
156 if ($this->_soInstance
) {
160 $this->assign('stringOverrideInstances', empty($stringOverrideInstances) ?
FALSE : $stringOverrideInstances);
162 $this->addButtons(array(
165 'name' => ts('Save'),
170 'name' => ts('Cancel'),
174 $this->addFormRule(array('CRM_Admin_Form_WordReplacements', 'formRule'), $this);
178 * global validation rules for the form
180 * @param array $values posted values of the form
182 * @return array list of errors to be posted back to the form
186 static function formRule($values) {
189 $oldValues = CRM_Utils_Array
::value('old', $values);
190 $newValues = CRM_Utils_Array
::value('new', $values);
191 $enabled = CRM_Utils_Array
::value('enabled', $values);
192 $exactMatch = CRM_Utils_Array
::value('cb', $values);
194 foreach ($oldValues as $k => $v) {
195 if ($v && !$newValues[$k]) {
196 $errors['new[' . $k . ']'] = ts('Please Enter the value for Replacement Word');
198 elseif (!$v && $newValues[$k]) {
199 $errors['old[' . $k . ']'] = ts('Please Enter the value for Original Word');
201 elseif ((empty($newValues[$k]) && empty($oldValues[$k]))
202 && (!empty($enabled[$k]) ||
!empty($exactMatch[$k]))
204 $errors['old[' . $k . ']'] = ts('Please Enter the value for Original Word');
205 $errors['new[' . $k . ']'] = ts('Please Enter the value for Replacement Word');
213 * Function to process the form
219 public function postProcess() {
220 $params = $this->controller
->exportValues($this->_name
);
221 $this->_numStrings
= sizeof($params['old']);
223 $enabled['exactMatch'] = $enabled['wildcardMatch'] = $disabled['exactMatch'] = $disabled['wildcardMatch'] = array();
224 for ($i = 1; $i <= $this->_numStrings
; $i++
) {
225 if (!empty($params['new'][$i]) && !empty($params['old'][$i])) {
226 if (isset($params['enabled']) && !empty($params['enabled'][$i])) {
227 if (!empty($params['cb']) && !empty($params['cb'][$i])) {
228 $enabled['exactMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
231 $enabled['wildcardMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
235 if (isset($params['cb']) && is_array($params['cb']) && array_key_exists($i, $params['cb'])) {
236 $disabled['exactMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
239 $disabled['wildcardMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
246 'enabled' => $enabled,
247 'disabled' => $disabled,
250 $config = CRM_Core_Config
::singleton();
252 $domain = new CRM_Core_DAO_Domain();
255 if ($domain->locales
&& $config->localeCustomStrings
) {
257 $addReplacements = $config->localeCustomStrings
;
258 $addReplacements[$config->lcMessages
] = $overrides;
259 $stringOverride = serialize($addReplacements);
262 // for single language
263 $stringOverride = serialize(array($config->lcMessages
=> $overrides));
266 $params = array('locale_custom_strings' => $stringOverride);
267 $id = CRM_Core_Config
::domainID();
269 $wordReplacementSettings = CRM_Core_BAO_Domain
::edit($params, $id);
271 if ($wordReplacementSettings) {
272 // This controller was originally written to CRUD $config->locale_custom_strings,
273 // but that's no longer the canonical store. Sync changes to canonical store.
274 // This is inefficient - at some point, we should rewrite this UI.
275 CRM_Core_BAO_WordReplacement
::rebuildWordReplacementTable();
277 CRM_Core_Session
::setStatus("", ts("Settings Saved"), "success");
278 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/options/wordreplacements',