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
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();
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);
60 public function setDefaultValues() {
61 if ($this->_defaults
!== NULL) {
62 return $this->_defaults
;
65 $this->_defaults
= array();
67 $config = CRM_Core_Config
::singleton();
69 $values = $config->localeCustomStrings
[$config->lcMessages
];
72 $enableDisable = array(
77 $cardMatch = array('wildcardMatch', 'exactMatch');
79 foreach ($enableDisable as $key => $val) {
80 foreach ($cardMatch as $kc => $vc) {
81 if (!empty($values[$val][$vc])) {
82 foreach ($values[$val][$vc] as $k => $v) {
83 $this->_defaults
["enabled"][$i] = $key;
84 $this->_defaults
["cb"][$i] = $kc;
85 $this->_defaults
["old"][$i] = $k;
86 $this->_defaults
["new"][$i] = $v;
93 $name = $this->_stringName
= "custom_string_override_{$config->lcMessages}";
94 if (isset($config->$name) &&
95 is_array($config->$name)
97 $this->_numStrings
= 1;
98 foreach ($config->$name as $old => $newValues) {
100 $this->_numStrings +
= 9;
104 $this->_numStrings
= 10;
107 return $this->_defaults
;
111 * Function to actually build the form
116 public function buildQuickForm() {
117 $config = CRM_Core_Config
::singleton();
118 $values = $config->localeCustomStrings
[$config->lcMessages
];
122 foreach ( $values as $valMatchType ) {
123 foreach ( $valMatchType as $valPairs ) {
124 $instances +
= count($valPairs);
128 if ($instances > 10) {
129 $this->_numStrings
= $instances;
132 $soInstances = range(1, $this->_numStrings
, 1);
133 $stringOverrideInstances = array();
134 if ($this->_soInstance
) {
135 $soInstances = array($this->_soInstance
);
137 elseif (!empty($_POST['old'])) {
138 $soInstances = $stringOverrideInstances = array_keys($_POST['old']);
140 elseif (!empty($this->_defaults
) && is_array($this->_defaults
)) {
141 $stringOverrideInstances = array_keys($this->_defaults
['new']);
142 if (count($this->_defaults
['old']) > count($this->_defaults
['new'])) {
143 $stringOverrideInstances = array_keys($this->_defaults
['old']);
146 foreach ($soInstances as $instance) {
147 $this->addElement('checkbox', "enabled[$instance]");
148 $this->add('textarea', "old[$instance]", NULL, array('rows' => 1, 'cols' => 40));
149 $this->add('textarea', "new[$instance]", NULL, array('rows' => 1, 'cols' => 40));
150 $this->addElement('checkbox', "cb[$instance]");
152 $this->assign('numStrings', $this->_numStrings
);
153 if ($this->_soInstance
) {
157 $this->assign('stringOverrideInstances', empty($stringOverrideInstances) ?
FALSE : $stringOverrideInstances);
159 $this->addButtons(array(
162 'name' => ts('Save'),
167 'name' => ts('Cancel'),
171 $this->addFormRule(array('CRM_Admin_Form_WordReplacements', 'formRule'), $this);
175 * global validation rules for the form
177 * @param array $values posted values of the form
179 * @return array list of errors to be posted back to the form
183 static function formRule($values) {
186 $oldValues = CRM_Utils_Array
::value('old', $values);
187 $newValues = CRM_Utils_Array
::value('new', $values);
188 $enabled = CRM_Utils_Array
::value('enabled', $values);
189 $exactMatch = CRM_Utils_Array
::value('cb', $values);
191 foreach ($oldValues as $k => $v) {
192 if ($v && !$newValues[$k]) {
193 $errors['new[' . $k . ']'] = ts('Please Enter the value for Replacement Word');
195 elseif (!$v && $newValues[$k]) {
196 $errors['old[' . $k . ']'] = ts('Please Enter the value for Original Word');
198 elseif ((empty($newValues[$k]) && empty($oldValues[$k]))
199 && (!empty($enabled[$k]) ||
!empty($exactMatch[$k]))
201 $errors['old[' . $k . ']'] = ts('Please Enter the value for Original Word');
202 $errors['new[' . $k . ']'] = ts('Please Enter the value for Replacement Word');
210 * Function to process the form
216 public function postProcess() {
217 $params = $this->controller
->exportValues($this->_name
);
218 $this->_numStrings
= sizeof($params['old']);
220 $enabled['exactMatch'] = $enabled['wildcardMatch'] = $disabled['exactMatch'] = $disabled['wildcardMatch'] = array();
221 for ($i = 1; $i <= $this->_numStrings
; $i++
) {
222 if (!empty($params['new'][$i]) && !empty($params['old'][$i])) {
223 if (isset($params['enabled']) && !empty($params['enabled'][$i])) {
224 if (!empty($params['cb']) && !empty($params['cb'][$i])) {
225 $enabled['exactMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
228 $enabled['wildcardMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
232 if (isset($params['cb']) && is_array($params['cb']) && array_key_exists($i, $params['cb'])) {
233 $disabled['exactMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
236 $disabled['wildcardMatch'] +
= array($params['old'][$i] => $params['new'][$i]);
243 'enabled' => $enabled,
244 'disabled' => $disabled,
247 $config = CRM_Core_Config
::singleton();
249 $domain = new CRM_Core_DAO_Domain();
252 if ($domain->locales
&& $config->localeCustomStrings
) {
254 $addReplacements = $config->localeCustomStrings
;
255 $addReplacements[$config->lcMessages
] = $overrides;
256 $stringOverride = serialize($addReplacements);
259 // for single language
260 $stringOverride = serialize(array($config->lcMessages
=> $overrides));
263 $params = array('locale_custom_strings' => $stringOverride);
264 $id = CRM_Core_Config
::domainID();
266 $wordReplacementSettings = CRM_Core_BAO_Domain
::edit($params, $id);
268 if ($wordReplacementSettings) {
269 // This controller was originally written to CRUD $config->locale_custom_strings,
270 // but that's no longer the canonical store. Sync changes to canonical store.
271 // This is inefficient - at some point, we should rewrite this UI.
272 CRM_Core_BAO_WordReplacement
::rebuildWordReplacementTable();
274 CRM_Core_Session
::setStatus("", ts("Settings Saved"), "success");
275 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/admin/options/wordreplacements',