Subversion-Projekte lars-tiefland.php_share

Revision

Details | Letzte Änderung | Log anzeigen | RSS feed

Revision Autor Zeilennr. Zeile
1 lars 1
<?php
2
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
3
 
4
/**
5
 * Contains the Translation2_Decorator_SpecialChars class
6
 *
7
 * PHP versions 4 and 5
8
 *
9
 * LICENSE: Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 * 3. The name of the author may not be used to endorse or promote products
17
 *    derived from this software without specific prior written permission.
18
 *
19
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
20
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22
 * IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
23
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
 *
30
 * @category  Internationalization
31
 * @package   Translation2
32
 * @author    Lorenzo Alberton <l.alberton@quipo.it>
33
 * @copyright 2004-2007 Lorenzo Alberton
34
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
35
 * @version   CVS: $Id: SpecialChars.php 305985 2010-12-05 22:55:33Z clockwerx $
36
 * @link      http://pear.php.net/package/Translation2
37
 */
38
 
39
/**
40
 * Load Translation2 decorator base class
41
 */
42
require_once 'Translation2/Decorator.php';
43
 
44
/**
45
 * Decorator to replace special chars with the matching html entities.
46
 *
47
 * You can set the charset to use (the default being 'ISO-8859-1'):
48
 * <code>
49
 * $tr->setOptions(array('charset' => 'UTF-8'));
50
 * </code>
51
 *
52
 * @category  Internationalization
53
 * @package   Translation2
54
 * @author    Lorenzo Alberton <l.alberton@quipo.it>
55
 * @copyright 2004-2007 Lorenzo Alberton
56
 * @license   http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
57
 * @version   CVS: $Id: SpecialChars.php 305985 2010-12-05 22:55:33Z clockwerx $
58
 * @link      http://pear.php.net/package/Translation2
59
 * @see       http://www.php.net/htmlentities for a list of available charsets.
60
 */
61
class Translation2_Decorator_SpecialChars extends Translation2_Decorator
62
{
63
    // {{{ class vars
64
 
65
    /**
66
     * @var string
67
     * @access protected
68
     */
69
    var $charset = 'ISO-8859-1';
70
 
71
    // }}}
72
    // {{{ get()
73
 
74
    /**
75
     * Get translated string
76
     *
77
     * replace special chars with the matching html entities
78
     *
79
     * @param string $stringID    string ID
80
     * @param string $pageID      page/group ID
81
     * @param string $langID      language ID
82
     * @param string $defaultText Text to display when the string is empty
83
     *
84
     * @return string
85
     */
86
    function get($stringID, $pageID=TRANSLATION2_DEFAULT_PAGEID, $langID=null, $defaultText=null)
87
    {
88
        $str = $this->translation2->get($stringID, $pageID, $langID, $defaultText);
89
        if (PEAR::isError($str)) {
90
            return $str;
91
        }
92
        if (!empty($str)) {
93
            $str = htmlentities($str, ENT_QUOTES, $this->charset);
94
        }
95
        return $str;
96
    }
97
 
98
    // }}}
99
    // {{{ getPage()
100
 
101
    /**
102
     * Same as getRawPage, but apply transformations when needed
103
     *
104
     * @param string $pageID page/group ID
105
     * @param string $langID language ID
106
     *
107
     * @return array
108
     */
109
    function getPage($pageID=TRANSLATION2_DEFAULT_PAGEID, $langID=null)
110
    {
111
        $data = $this->translation2->getPage($pageID, $langID);
112
        if (PEAR::isError($data)) {
113
            return $data;
114
        }
115
        foreach ($data as $key => $val) {
116
            if (!empty($val)) {
117
                $data[$key] = htmlentities($val, ENT_QUOTES, $this->charset);
118
            }
119
        }
120
        return $data;
121
    }
122
 
123
    // }}}
124
}
125
?>