File: Zend_Translate-Using.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (308 lines) | stat: -rw-r--r-- 10,924 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: 22760 -->
<sect1 id="zend.translate.using">
    <title>Verwendung der Übersetzungsadapter</title>

    <para>
        Der nächste Schritt ist die Benutzung des Adapters im eigenen Code.
    </para>

    <example id="zend.translate.using.example1">
        <title>Beispiel eines einsprachigen PHP Codes</title>

        <programlisting language="php"><![CDATA[
print "Beispiel\n";
print "========\n";
print "Hier steht Zeile eins\n";
print "Heute ist der " . date("d.m.Y") . "\n";
print "\n";
print "Hier ist Zeile zwei\n";
]]></programlisting>
    </example>

    <para>
        Das obige Beispiel zeigt eine Ausgabe ohne Unterstützung für Übersetzungen. Der Code wird
        üblicherweise in der eigenen Muttersprache geschrieben. Üblicherweise muß nicht nur die
        Ausgabe übersetzt werden, sondern auch Fehler- und Logmeldungen.
    </para>

    <para>
        Der nächste Schritt ist also die Integration von <classname>Zend_Translate</classname> in
        den eigenen Code. Natürlich ist es viel einfacher, wenn bei der Erstellung des Codes bereits
        an die Übersetzung gedacht wurde, anstatt ihn im Nachhinein dafür zu ändern.
    </para>

    <example id="zend.translate.using.example2">
        <title>Beispiel für mehrsprachigen PHP Code</title>

        <programlisting language="php"><![CDATA[
$translate = new Zend_Translate(
    array(
        'adapter' => 'gettext',
        'content' => '/path/to/translation/source-de.mo',
        'locale'  => 'de'
    )
);
$translate->addTranslation(
    array(
        'content' => '//my/path/fr-source.mo',
        'locale   => 'fr'
    )
);

print $translate->_("Beispiel") . "\n";
print "========\n";
print $translate->_("Hier steht Zeile eins") . "\n";
printf($translate->_("Heute ist der %1\$s") . "\n", date('d.m.Y'));
print "\n";

$translate->setLocale('fr');
print $translate->_("Hier ist Zeile zwei") . "\n";
]]></programlisting>
    </example>

    <para>
        Jetzt schauen wir uns genauer an, was getan wurde und wie
        <classname>Zend_Translate</classname> in den eigenen Code integriert wird.
    </para>

    <para>
        Erstelle ein neues <classname>Zend_Translate</classname> Objekt und definiere den
        Basisadapter:
    </para>

    <programlisting language="php"><![CDATA[
$translate = new Zend_Translate(
    array(
        'adapter' => 'gettext',
        'content' => '/path/to/translation/source-de.mo',
        'locale'  => 'de'
    )
);
]]></programlisting>

    <para>
        In diesem Beispiel haben wir den <emphasis>Gettext-Adapter</emphasis>
        ausgewählt. Die Übersetzungsdatei <emphasis>source-de.mo</emphasis> wird im
        Verzeichnis <emphasis>/path/to/translation</emphasis> platziert. Diese
        Gettext-Datei beinhaltet eine deutsche Übersetzung und es steht auch eine zweite
        Sprachquelle für Französisch zur Verfügung.
    </para>

    <para>
        Der nächste Schritt besteht darin, alle Strings zu ummanteln, die übersetzt werden sollen.
        Die einfachste Möglichkeit besteht, wenn nur einfache Strings oder Sätze vorhanden sind
        wie zum Beispiel:
    </para>

    <programlisting language="php"><![CDATA[
print $translate->_("Beispiel") . "\n";
print "========\n";
print $translate->_("Hier ist die Zeile Eins") . "\n";
]]></programlisting>

    <para>
        Einige Strings müssen nicht übersetzt werden. Die Trennlinie wird immer eine Trennlinie
        sein, auch in den anderen Sprachen.
    </para>

    <para>
        Die Verwendung von variablen Werten in einer Übersetzung wird durch die Verwendung
        von eingebetteten Parametern auch unterstützt.
    </para>

    <programlisting language="php"><![CDATA[
printf($translate->_("Today is the %1\$s") . "\n", date("d.m.Y"));
]]></programlisting>

    <para>
        Statt <methodname>print()</methodname> wird die <methodname>printf()</methodname> Funktion
        benutzt und alle variablen Parameter mit <emphasis>%1\$s</emphasis> Blöcken ersetzt.
        Der erste ist <emphasis>%1\$s</emphasis>, der zweite ist <emphasis>%2\$s</emphasis>, und so
        weiter. Auf diesen Weg kann übersetzt werden, ohne den exakten Wert zu wissen. In unserem
        Beispiel ist das Datum immer der aktuelle Tag, aber der String kann übersetzt
        werden, ohne über den aktuellen Tag Bescheid zu wissen.
    </para>

    <para>
        Jeder String wird im Übersetzungsspeicher durch seine Message ID identifiziert.
        Man könnte diese Message IDs statt des Strings im Code wie folgt verwenden:
    </para>

    <programlisting language="php"><![CDATA[
print $translate->_(1) . "\n";
print "=======\n";
print $translate->_(2) . "\n";
]]></programlisting>

    <para>
        Allerdings hat dies mehrere Nachteile:
    </para>

    <para>
        Es ist nicht erkennbar, was der Code ausgeben sollte, wenn man ihn betrachtet.
    </para>

    <para>
        Es werden auch Probleme auftreten, wenn einige Strings nicht übersetzt worden sind. Man muß
        sich immer vor Augen halten, wie Übersetzungen funktionieren. Zuerst prüft
        <classname>Zend_Translate</classname> ob in der gesetzten Sprache für die angegebene
        Message ID oder den String eine Übersetzung vorhanden ist. Wenn keine Übersetzung gefunden
        wurde, wird in der nächsten tiefer gelegenen Sprache gesucht wie in
        <classname>Zend_Locale</classname> definiert. "<emphasis>de_AT</emphasis>" wird also zu
        "<emphasis>de</emphasis>". Wenn auch hier keine Übersetzung in der Sprache
        "<emphasis>de</emphasis>" gefunden wurde, wird der Original-String zurück
        gegeben. Das bedeutet also, dass immer eine Ausgabe existiert, selbst wenn für eine Message
        ID keine Übersetzung in der Quelle vorhanden ist. <classname>Zend_Translate</classname> wird
        niemals eine Exception oder einen Fehler ausgeben, wenn ein String übersetzt werden soll.
    </para>

    <sect2 id="zend.translate.using.structure">
        <title>Strukturen für Übersetzungdateien</title>

        <para>
            Der nächste Schritt besteht in der Erstellung der Übersetzungsdateien für die
            verschiedenen Sprachen, welche übersetzt werden sollen. Jeder Adapter wird,
            wie hier beschrieben, auf seine eigene Weise erstellt, aber es gibt ein
            paar allgemeine Features, die für alle Adapter relevant sind.
        </para>

        <para>
            Zuerst muß entschieden werden, wo die Übersetzungsdateien zu speichern sind. Bei der
            Verwendung von <classname>Zend_Translate</classname> gibt es keinerlei Einschränkungen.
            Die folgenden Strukturen sind vorzuziehen:
        </para>

        <itemizedlist>
            <listitem>
                <para>Einzeln strukturierte Quellen</para>

                <programlisting language="txt"><![CDATA[
/application/
/languages/
/languages/lang.en
/languages/lang.de
/library/
]]></programlisting>

                <para>
                    Positiv: Alle Quelldateien, für jede Sprache, werden in einem einzelnen
                    Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.
                </para>
            </listitem>

            <listitem>
                <para>Sprachlich stukturierte Quellen</para>

                <programlisting language="txt"><![CDATA[
/application/
/languages/
/languages/en/
/languages/en/first.en
/languages/en/second.en
/languages/de/
/languages/de/first.de
/languages/de/second.de
/library/
]]></programlisting>

                <para>
                    Positiv: Jede Sprache wird in ihrem eigenen Verzeichnis gespeichert. Einfache
                    Übersetzung, da jedes Übersetzungsteam nur ein einzelnes Verzeichnis zu
                    übersetzen hat. Auch die Verwendung von mehreren Dateien ist
                    transparent.
                </para>
            </listitem>

            <listitem>
                <para>Anwendungsstrukturierte Quellen</para>

                <programlisting language="txt"><![CDATA[
/application/
/application/languages/
/application/languages/first.en
/application/languages/first.de
/application/languages/second.en
/application/languages/second.de
/library/
]]></programlisting>

                <para>
                    Positiv: Alle Quelldateien, für jede Sprache, werden in einem einzelnen
                    Verzeichnis gespeichert. Keine Aufteilung der betreffenden Dateien.
                </para>

                <para>
                    Negativ: Die Benutzung von mehreren Dateien für dieselbe Sprache kann
                    problematisch sein.
                </para>
            </listitem>

            <listitem>
                <para>Gettext strukturierte Quellen</para>

                <programlisting language="txt"><![CDATA[
/application/
/languages/
/languages/de/
/languages/de/LC_MESSAGES/
/languages/de/LC_MESSAGES/first.mo
/languages/de/LC_MESSAGES/second.mo
/languages/en/
/languages/en/LC_MESSAGES/
/languages/en/LC_MESSAGES/first.mo
/languages/en/LC_MESSAGES/second.mo
/library/
]]></programlisting>

                <para>
                    Positiv: Bestehende Gettext-Quellen können ohne Veränderung der Struktur
                    benutzt werden.
                </para>

                <para>
                    Negativ: Die Benutzung von Unterunterverzeichnissen ist für Personen verwirrend,
                    die Gettext noch nie benutzt haben.
                </para>
            </listitem>

            <listitem>
                <para>Datei strukturierte Quellen</para>

                <programlisting language="txt"><![CDATA[
/application/
/application/models/
/application/models/MyModel.php
/application/models/MyModel.de
/application/models/MyModel.en
/application/controllers/
/application/controllers/MyController.php
/application/controllers/MyController.de
/application/controllers/MyController.en
/library/
]]></programlisting>

                <para>
                    Positiv: Übersetzungsdateien sind in der Nähe ihrer Quelle zu finden.
                </para>

                <para>
                    Negativ: Zu viele und auch kleine Übersetzungsdateien führen zu einer
                    schwierigen und langwierigen Übersetzung. Es muß auch jede Datei als
                    Übersetzungsquelle hinzugefügt werden.
                </para>
            </listitem>
        </itemizedlist>

        <para>
            Einzeln strukturierte und sprachlich strukturierte Quelldateien sind
            für <classname>Zend_Translate</classname> am besten benutzbar.
        </para>

        <para>
            Da jetzt bekannt ist, welche Struktur verwendet wird,
            sollten nun die einzelnen Übersetzungsdateien erstellt werden.
        </para>
    </sect2>
</sect1>