/
Decorator.php
416 lines (371 loc) · 10.5 KB
/
Decorator.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Contains the Translation2_Decorator base class
*
* PHP versions 4 and 5
*
* LICENSE: Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category Internationalization
* @package Translation2
* @author Lorenzo Alberton <l.alberton@quipo.it>
* @copyright 2004-2005 Lorenzo Alberton
* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
* @version CVS: $Id$
* @link http://pear.php.net/package/Translation2
*/
/**
* Translation2_Decorator. Base Decorator class for Translation2
*
* Extend this class to provide custom decorators.
* Some decorators are already bundled with the package.
*
* @category Internationalization
* @package Translation2
* @author Lorenzo Alberton <l.alberton@quipo.it>
* @copyright 2004-2005 Lorenzo Alberton
* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
* @link http://pear.php.net/package/Translation2
* @abstract
*/
class Translation2_Decorator extends Translation2
{
// {{{ class vars
/**
* Translation2 object being decorated
* @var object
* @access protected
*/
var $translation2;
/**
* @var object
* @access protected
*/
var $storage;
/**
* @var array
* @access protected
*/
var $lang;
/**
* @var string
* @access protected
*/
var $currentPageID;
// }}}
// {{{ Constructor
/**
* Constructor
* Constructs the Translation2_Decorator
*
* @param object &$translation2 Translation2 object to decorate
*/
function Translation2_Decorator(& $translation2)
{
$this->translation2 = & $translation2;
//used for debug only
$this->storage = & $translation2->storage;
$this->currentPageID = & $translation2->currentPageID;
$this->lang = & $translation2->lang;
}
// }}}
// {{{ setOptions()
/**
* set Decorator options
*
* @param array $options decorator options
*
* @return self
*/
function setOptions($options=array())
{
if (is_array($options)) {
foreach ($options as $option => $value) {
$this->setOption($option, $value);
}
}
return $this;
}
// }}}
// {{{ setOption()
/**
* set Decorator option
*
* @param string $option option name
* @param mixed $value option value
*
* @return self
*/
function setOption($option, $value=null)
{
if (isset($this->$option)) {
$this->$option = $value;
} elseif (is_a($this->translation2, 'Translation2_Decorator')) {
$this->translation2->setOption($option, $value);
}
return $this;
}
// }}}
// {{{ setContainerOptions()
/**
* Set some storage driver options
*
* @param array $options storage driver options
*
* @return void
* @access protected
*/
function setContainerOptions($options)
{
$this->storage->_parseOptions($options);
}
// }}}
// {{{ getDecorator()
/**
* Return an instance of a decorator
*
* @param string $decorator Name of the decorator
* @param object $object instance [optional]
*
* @return object Decorator object reference
* @access public
*/
function & getDecorator($decorator)
{
if (func_num_args() > 1) {
$obj = func_get_arg(1);
$new_decorator =& $this->translation2->getDecorator($decorator, $obj);
} else {
$new_decorator =& $this->translation2->getDecorator($decorator, $this);
}
return $new_decorator;
}
// }}}
// {{{ setCharset()
/**
* Set charset used to read/store the translations
*
* @param string $charset character set (encoding)
*
* @return PEAR_Error on failure
*/
function setCharset($charset)
{
return $this->translation2->setCharset($charset);
}
// }}}
// {{{ setLang()
/**
* Set default language
*
* @param string $langID language ID
*
* @return true|PEAR_Error
*/
function setLang($langID)
{
return $this->translation2->setLang($langID);
}
// }}}
// {{{ setPageID($pageID)
/**
* Set default page
*
* @param string $pageID page/group ID
*
* @return void
*/
function setPageID($pageID = null)
{
$this->translation2->setPageID($pageID);
}
// }}}
// {{{ getLang()
/**
* Get language info
*
* @param string $langID language ID
* @param string $format ['name', 'meta', 'error_text', 'array']
*
* @return mixed [string | array], depending on $format
*/
function getLang($langID=null, $format='name')
{
return $this->translation2->getLang($langID, $format);
}
// }}}
// {{{ getLangs()
/**
* Get languages
*
* @param string $format ['ids', 'names', 'array']
*
* @return array
*/
function getLangs($format='name')
{
return $this->translation2->getLangs($format);
}
// }}}
// {{{ setParams()
/**
* Set parameters for next string
*
* @param array $params array of replacement parameters
*
* @return void
*/
function setParams($params = null)
{
$this->translation2->setParams($params);
}
// }}}
// {{{ getRaw()
/**
* Get translated string
*
* No filter is applied.
*
* @param string $stringID string ID
* @param string $pageID page/group ID
* @param string $langID language ID
* @param string $defaultText Text to display when the strings in both
* the default and the fallback lang are empty
*
* @return string
*/
function getRaw($stringID, $pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null, $defaultText = '')
{
return $this->translation2->getRaw($stringID, $pageID, $langID, $defaultText);
}
// }}}
// {{{ get()
/**
* Get translated string
*
* All the filters are applied.
*
* @param string $stringID string ID
* @param string $pageID page/group ID
* @param string $langID language ID
* @param string $defaultText Text to display when the string is empty
* NB: This parameter is only used in the DefaultText decorator
*
* @return string
*/
function get($stringID, $pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null, $defaultText = '')
{
return $this->translation2->get($stringID, $pageID, $langID, $defaultText);
}
// }}}
// {{{ getRawPage()
/**
* Get the array of strings in a page
*
* Fetch the strings from the container, without any replacing
*
* @param string $pageID page/group ID
* @param string $langID language ID
*
* @return array
*/
function getRawPage($pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null)
{
return $this->translation2->getRawPage($pageID, $langID);
}
// }}}
// {{{ getPage()
/**
* Same as getRawPage, but resort to fallback language and
* replace parameters when needed
*
* @param string $pageID page/group ID
* @param string $langID language ID
*
* @return array
*/
function getPage($pageID = TRANSLATION2_DEFAULT_PAGEID, $langID = null)
{
$this->translation2->getPage($pageID, $langID);
}
// }}}
// {{{ _replaceParams()
/**
* Replace parameters in strings
*
* @param mixed $strings strings where the replacements must occur
*
* @return mixed
* @access protected
*/
function _replaceParams($strings)
{
return $this->translation2->_replaceParams($strings);
}
// }}}
// {{{ replaceEmptyStringsWithKeys()
/**
* Replace empty strings with their stringID
*
* @param array $strings array of strings to be replaced if empty
*
* @return array
* @access public
*/
function replaceEmptyStringsWithKeys($strings)
{
return $this->translation2->replaceEmptyStringsWithKeys($strings);
}
// }}}
// {{{ getStringID()
/**
* Get the stringID for the given string. This method is the reverse of get().
*
* @param string $string This is NOT the stringID, this is a real string.
* The method will search for its matching stringID, and then
* it will return the associate string in the selected language.
* @param string $pageID page/group ID
*
* @return string
*/
function getStringID($string, $pageID = TRANSLATION2_DEFAULT_PAGEID)
{
return $this->translation2->getStringID($string, $pageID);
}
// }}}
// {{{ __clone()
/**
* Clone internal object references
*
* This method is called automatically by PHP5
*
* @return void
* @access protected
*/
function __clone()
{
$this->translation2 = clone($this->translation2);
}
// }}}
}
?>