Attributes.php
4.61 KB
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
<?php
/**
* PHPTAL templating engine
*
* PHP Version 5
*
* @category HTML
* @package PHPTAL
* @author Laurent Bedubourg <lbedubourg@motion-twin.com>
* @author Kornel Lesiński <kornel@aardvarkmedia.co.uk>
* @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License
* @version SVN: $Id: Attributes.php 605 2009-05-03 02:50:26Z kornel $
* @link http://phptal.org/
*/
/**
* i18n:attributes
*
* This attribute will allow us to translate attributes of HTML tags, such
* as the alt attribute in the img tag. The i18n:attributes attribute
* specifies a list of attributes to be translated with optional message
* IDs? for each; if multiple attribute names are given, they must be
* separated by semi-colons. Message IDs? used in this context must not
* include whitespace.
*
* Note that the value of the particular attributes come either from the
* HTML attribute value itself or from the data inserted by tal:attributes.
*
* If an attibute is to be both computed using tal:attributes and translated,
* the translation service is passed the result of the TALES expression for
* that attribute.
*
* An example:
*
* <img src="http://foo.com/logo" alt="Visit us"
* tal:attributes="alt here/greeting"
* i18n:attributes="alt"
* />
*
*
* In this example, let tal:attributes set the value of the alt attribute to
* the text "Stop by for a visit!". This text will be passed to the
* translation service, which uses the result of language negotiation to
* translate "Stop by for a visit!" into the requested language. The example
* text in the template, "Visit us", will simply be discarded.
*
* Another example, with explicit message IDs:
*
* <img src="../icons/uparrow.png" alt="Up"
* i18n:attributes="src up-arrow-icon; alt up-arrow-alttext"
* >
*
* Here, the message ID up-arrow-icon will be used to generate the link to
* an icon image file, and the message ID up-arrow-alttext will be used for
* the "alt" text.
*
*
*
* @package PHPTAL
* @subpackage Php.attribute.i18n
*/
class PHPTAL_Php_Attribute_I18N_Attributes extends PHPTAL_Php_Attribute
{
public function before(PHPTAL_Php_CodeWriter $codewriter)
{
// split attributes to translate
foreach ($codewriter->splitExpression($this->expression) as $exp) {
list($qname, $key) = $this->parseSetExpression($exp);
// if the translation key is specified and not empty (but may be '0')
if (strlen($key)) {
// we use it and replace the tag attribute with the result of the translation
$code = $this->_getTranslationCode($codewriter, $key);
} else {
$attr = $this->phpelement->getAttributeNode($qname);
if (!$attr) throw new PHPTAL_TemplateException("Unable to translate attribute $qname, because there is no translation key specified");
if ($attr->getReplacedState() === PHPTAL_Dom_Attr::NOT_REPLACED) {
$code = $this->_getTranslationCode($codewriter, $attr->getValue());
} elseif ($attr->getReplacedState() === PHPTAL_Dom_Attr::VALUE_REPLACED && $attr->getOverwrittenVariableName()) {
// sadly variables won't be interpolated in this translation
$code = 'echo '.$codewriter->escapeCode('$_translator->translate('.$attr->getOverwrittenVariableName().', false)');
} else {
throw new PHPTAL_TemplateException("Unable to translate attribute $qname, because other TAL attributes are using it");
}
}
$this->phpelement->getOrCreateAttributeNode($qname)->overwriteValueWithCode($code);
}
}
public function after(PHPTAL_Php_CodeWriter $codewriter)
{
}
/**
* @param key - unescaped string (not PHP code) for the key
*/
private function _getTranslationCode(PHPTAL_Php_CodeWriter $codewriter, $key)
{
$code = '';
if (preg_match_all('/\$\{(.*?)\}/', $key, $m)) {
array_shift($m);
$m = array_shift($m);
foreach ($m as $name) {
$code .= "\n".'$_translator->setVar('.$codewriter->str($name).','.PHPTAL_Php_TalesInternal::compileToPHPExpression($name).');'; // allow more complex TAL expressions
}
$code .= "\n";
}
// notice the false boolean which indicate that the html is escaped
// elsewhere looks like an hack doesn't it ? :)
$code .= 'echo '.$codewriter->escapeCode('$_translator->translate('.$codewriter->str($key).', false)');
return $code;
}
}