Commit | Line | Data |
---|---|---|
d83a3991 | 1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.4 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * | |
38 | */ | |
39 | class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { | |
40 | ||
41 | function __construct() { | |
42 | parent::__construct(); | |
6cf5bb6f | 43 | } |
d83a3991 | 44 | /** |
45 | * Takes a bunch of params that are needed to match certain criteria and | |
6cf5bb6f | 46 | * retrieves the relevant objects. |
d83a3991 | 47 | * |
48 | * @param array $params (reference ) an assoc array of name/value pairs | |
49 | * @param array $defaults (reference ) an assoc array to hold the flattened values | |
50 | * | |
51 | * @return object CRM_Core_DAO_WordRepalcement object | |
52 | * @access public | |
53 | * @static | |
54 | */ | |
6cf5bb6f | 55 | |
d83a3991 | 56 | static function retrieve(&$params, &$defaults) { |
57 | return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_WordRepalcement', $params, $defaults); | |
58 | } | |
59 | ||
60 | /** | |
61 | * Get the domain BAO | |
62 | * | |
63 | * @return null|object CRM_Core_BAO_WordRepalcement | |
64 | * @access public | |
65 | * @static | |
66 | */ | |
f01484bc | 67 | static function getWordReplacement($reset = NULL) { |
d83a3991 | 68 | static $wordReplacement = NULL; |
69 | if (!$wordReplacement || $reset) { | |
70 | $wordReplacement = new CRM_Core_BAO_WordRepalcement(); | |
71 | $wordReplacement->id = CRM_Core_Config::wordReplacementID(); | |
72 | if (!$wordReplacement->find(TRUE)) { | |
73 | CRM_Core_Error::fatal(); | |
74 | } | |
75 | } | |
76 | return $wordReplacement; | |
77 | } | |
78 | ||
79 | ||
80 | /** | |
81 | * Save the values of a WordReplacement | |
82 | * | |
83 | * @return WordReplacement array | |
84 | * @access public | |
85 | */ | |
86 | static function edit(&$params, &$id) { | |
87 | $wordReplacement = new CRM_Core_DAO_WordReplacement(); | |
88 | $wordReplacement->id = $id; | |
89 | $wordReplacement->copyValues($params); | |
90 | $wordReplacement->save(); | |
63b71ea8 TO |
91 | if (!isset($params['options']) || CRM_Utils_Array::value('wp-rebuild', $params['options'], TRUE)) { |
92 | self::rebuild(); | |
93 | } | |
d83a3991 | 94 | return $wordReplacement; |
95 | } | |
96 | ||
97 | /** | |
98 | * Create a new WordReplacement | |
99 | * | |
100 | * @return WordReplacement array | |
101 | * @access public | |
102 | */ | |
103 | static function create($params) { | |
f01484bc | 104 | if(array_key_exists("domain_id",$params) === FALSE) { |
6cf5bb6f DL |
105 | $params["domain_id"] = CRM_Core_Config::domainID(); |
106 | } | |
d83a3991 | 107 | $wordReplacement = new CRM_Core_DAO_WordReplacement(); |
108 | $wordReplacement->copyValues($params); | |
109 | $wordReplacement->save(); | |
63b71ea8 TO |
110 | if (!isset($params['options']) || CRM_Utils_Array::value('wp-rebuild', $params['options'], TRUE)) { |
111 | self::rebuild(); | |
112 | } | |
d83a3991 | 113 | return $wordReplacement; |
114 | } | |
6cf5bb6f | 115 | |
d83a3991 | 116 | /** |
117 | * Delete website | |
118 | * | |
119 | * @param int $id WordReplacement id | |
120 | * | |
121 | * @return object | |
122 | * @static | |
123 | */ | |
124 | static function del($id) { | |
125 | $dao = new CRM_Core_DAO_WordReplacement(); | |
126 | $dao->id = $id; | |
127 | $dao->delete(); | |
63b71ea8 TO |
128 | if (!isset($params['options']) || CRM_Utils_Array::value('wp-rebuild', $params['options'], TRUE)) { |
129 | self::rebuild(); | |
130 | } | |
d83a3991 | 131 | return $dao; |
132 | } | |
d83a3991 | 133 | |
f01484bc TO |
134 | /** |
135 | * Get all word-replacements in the form of an array | |
136 | * | |
137 | * @param int $id domain ID | |
138 | * @return array | |
139 | * @see civicrm_domain.locale_custom_strings | |
140 | */ | |
141 | public static function getAllAsConfigArray($id) { | |
6cf5bb6f DL |
142 | $query = " |
143 | SELECT find_word,replace_word,is_active,match_type | |
144 | FROM civicrm_word_replacement | |
145 | WHERE domain_id = %1 | |
146 | "; | |
147 | $params = array( 1 => array($id, 'Integer')); | |
148 | ||
149 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
150 | ||
151 | $overrides = array(); | |
152 | ||
d83a3991 | 153 | while ($dao->fetch()) { |
675605a7 | 154 | if ($dao->is_active==1) { |
155 | $overrides['enabled'][$dao->match_type][$dao->find_word] = $dao->replace_word; | |
156 | } else { | |
157 | $overrides['disabled'][$dao->match_type][$dao->find_word] = $dao->replace_word; | |
158 | } | |
d83a3991 | 159 | } |
d83a3991 | 160 | $config = CRM_Core_Config::singleton(); |
161 | $domain = new CRM_Core_DAO_Domain(); | |
162 | $domain->find(TRUE); | |
163 | ||
164 | if ($domain->locales && $config->localeCustomStrings) { | |
165 | // for multilingual | |
166 | $addReplacements = $config->localeCustomStrings; | |
167 | $addReplacements[$config->lcMessages] = $overrides; | |
f01484bc | 168 | $stringOverride = $addReplacements; |
d83a3991 | 169 | } |
170 | else { | |
171 | // for single language | |
f01484bc | 172 | $stringOverride = array($config->lcMessages => $overrides); |
d83a3991 | 173 | } |
174 | ||
f01484bc TO |
175 | return $stringOverride; |
176 | } | |
d83a3991 | 177 | |
f01484bc TO |
178 | /** |
179 | * Rebuild | |
180 | */ | |
181 | static function rebuild() { | |
182 | $id = CRM_Core_Config::domainID(); | |
183 | $stringOverride = self::getAllAsConfigArray($id); | |
184 | $params = array('locale_custom_strings' => serialize($stringOverride)); | |
d83a3991 | 185 | $wordReplacementSettings = CRM_Core_BAO_Domain::edit($params, $id); |
d83a3991 | 186 | if ($wordReplacementSettings) { |
0f65e834 TO |
187 | CRM_Core_Config::singleton()->localeCustomStrings = $stringOverride; |
188 | ||
d83a3991 | 189 | // Reset navigation |
190 | CRM_Core_BAO_Navigation::resetNavigation(); | |
191 | // Clear js string cache | |
192 | CRM_Core_Resources::singleton()->flushStrings(); | |
f01484bc TO |
193 | |
194 | return TRUE; | |
d83a3991 | 195 | } |
f01484bc TO |
196 | |
197 | return FALSE; | |
d83a3991 | 198 | } |
0f65e834 TO |
199 | |
200 | /** | |
201 | * Get all the word-replacements stored in config-arrays | |
202 | * and convert them to params for the WordReplacement.create API. | |
203 | * | |
204 | * Note: This function is duplicated in CRM_Core_BAO_WordReplacement and | |
205 | * CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade | |
206 | * step behaves consistently even as the BAO evolves in future versions. | |
207 | * However, if there's a bug in here prior to 4.4.0, we should apply the | |
208 | * bugfix in both places. | |
209 | * | |
210 | * @param bool $rebuildEach whether to perform rebuild after each individual API call | |
211 | * @return array Each item is $params for WordReplacement.create | |
212 | * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams | |
213 | */ | |
214 | static function getConfigArraysAsAPIParams($rebuildEach) { | |
215 | $wordReplacementCreateParams = array(); | |
216 | // get all domains | |
217 | $result = civicrm_api3('domain', 'get', array( | |
675605a7 | 218 | 'return' => array('locale_custom_strings'), |
219 | )); | |
0f65e834 TO |
220 | if (!empty($result["values"])) { |
221 | foreach ($result["values"] as $value) { | |
222 | $params = array(); | |
0f65e834 TO |
223 | $params["domain_id"] = $value["id"]; |
224 | $params["options"] = array('wp-rebuild' => $rebuildEach); | |
225 | // unserialize word match string | |
226 | $localeCustomArray = unserialize($value["locale_custom_strings"]); | |
227 | if (!empty($localeCustomArray)) { | |
228 | $wordMatchArray = array(); | |
675605a7 | 229 | // Traverse Language array |
0f65e834 | 230 | foreach ($localeCustomArray as $localCustomData) { |
675605a7 | 231 | // Traverse status array "enabled" "disabled" |
232 | foreach ($localCustomData as $status => $matchTypes) { | |
233 | $params["is_active"] = ($status == "enabled")?TRUE:FALSE; | |
234 | // Traverse Match Type array "wildcardMatch" "exactMatch" | |
235 | foreach ($matchTypes as $matchType => $words) { | |
236 | $params["match_type"] = $matchType; | |
237 | foreach ($words as $word => $replace) { | |
238 | $params["find_word"] = $word; | |
239 | $params["replace_word"] = $replace; | |
240 | $wordReplacementCreateParams[] = $params; | |
241 | } | |
242 | } | |
243 | } | |
0f65e834 TO |
244 | } |
245 | } | |
246 | } | |
247 | } | |
248 | return $wordReplacementCreateParams; | |
249 | } | |
250 | ||
251 | /** | |
252 | * Get all the word-replacements stored in config-arrays | |
253 | * and write them out as records in civicrm_word_replacement. | |
254 | * | |
255 | * Note: This function is duplicated in CRM_Core_BAO_WordReplacement and | |
256 | * CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade | |
257 | * step behaves consistently even as the BAO evolves in future versions. | |
258 | * However, if there's a bug in here prior to 4.4.0, we should apply the | |
259 | * bugfix in both places. | |
260 | */ | |
261 | public static function rebuildWordReplacementTable() { | |
262 | civicrm_api3('word_replacement', 'replace', array( | |
263 | 'options' => array('match' => array('domain_id', 'find_word')), | |
264 | 'values' => self::getConfigArraysAsAPIParams(FALSE), | |
265 | )); | |
266 | CRM_Core_BAO_WordReplacement::rebuild(); | |
267 | } | |
d83a3991 | 268 | } |
269 |