PageRenderTime 23ms CodeModel.GetById 12ms app.highlight 8ms RepoModel.GetById 1ms app.codeStats 0ms

/documentation/manual/de/module_specs/Zend_Barcode-Objects.xml

https://github.com/decaoz/zf1
XML | 406 lines | 334 code | 70 blank | 2 comment | 0 complexity | 423c64efb178b3ec0d85358ed417352b MD5 | raw file
  1<?xml version="1.0" encoding="UTF-8"?>
  2<!-- EN-Revision: 24249 -->
  3<!-- Reviewed: no -->
  4<sect1 id="zend.barcode.objects" xmlns:xi="http://www.w3.org/2001/XInclude">
  5    <title>Zend_Barcode Objekte</title>
  6
  7    <para>
  8        Barcode Objekte erlauben es Barcodes unabhängig von der Unterstützung eines Renderers zu
  9        erstellen. Nach der Erstellung kann der Barcode als Array von Zeichen Anweisungen empfangen
 10        werden die an einen Renderer übergeben werden können.
 11    </para>
 12
 13    <para>
 14        Objekte haben eine große Anzahl an Optionen. Die meisten von Ihnen sind allen Objekten
 15        gemein. Diese Optionen können auf vier Wegen gesetzt werden:
 16    </para>
 17
 18    <itemizedlist>
 19        <listitem>
 20            <para>
 21                Als Array oder <classname>Zend_Config</classname> Objekt welches dem Constructor
 22                übergeben wird.
 23            </para>
 24        </listitem>
 25
 26        <listitem>
 27            <para>
 28                Als Array das der <methodname>setOptions()</methodname> Methode übergeben wird.
 29            </para>
 30        </listitem>
 31
 32        <listitem>
 33            <para>
 34                Als <classname>Zend_Config</classname> Objekt welches der
 35                <methodname>setConfig()</methodname> Methode übergeben wird.
 36            </para>
 37        </listitem>
 38
 39        <listitem>
 40            <para>Über individuelle Setter für jeden Konfigurations Typ.</para>
 41        </listitem>
 42    </itemizedlist>
 43
 44    <example id="zend.barcode.objects.configuration">
 45        <title>Unterschiedliche Wege ein Barcode Objekt zu parametrisieren</title>
 46
 47        <programlisting language="php"><![CDATA[
 48$options = array('text' => 'ZEND-FRAMEWORK', 'barHeight' => 40);
 49
 50// Fall 1: Constructor
 51$barcode = new Zend_Barcode_Object_Code39($options);
 52
 53// Fall 2: setOptions()
 54$barcode = new Zend_Barcode_Object_Code39();
 55$barcode->setOptions($options);
 56
 57// Fall 3: setConfig()
 58$config  = new Zend_Config($options);
 59$barcode = new Zend_Barcode_Object_Code39();
 60$barcode->setConfig($config);
 61
 62// Fall 4: individuelle Setter
 63$barcode = new Zend_Barcode_Object_Code39();
 64$barcode->setText('ZEND-FRAMEWORK')
 65        ->setBarHeight(40);
 66]]></programlisting>
 67    </example>
 68
 69    <sect2 id="zend.barcode.objects.common.options">
 70        <title>Gemeinsame Optionen</title>
 71
 72        <para>
 73            In der folgenden Liste haben die Werte keine Einheit; wir werden den Ausdruck "Einheit"
 74            verwenden. Zum Beispiel, ist der Standardwert "dünner Balken" genau "1 Einheit". Die
 75            echte Einheit hängt von der Unterstützung beim Darstellen ab (siehe
 76            <link linkend="zend.barcode.renderers">die Renderer Dokumentation</link> für mehr
 77            Informationen). Setter werden benannt indem der erste Buchstabe der Option
 78            großgeschrieben und dem Namen "set" vorangestellt wird (z.B. "barHeight" =>
 79            "setBarHeight"). Alle Optionen haben einen entsprechenden Getter dem "get" vorangestellt
 80            ist (z.B. "getBarHeight"). Die vorhandenen Optionen sind:
 81        </para>
 82
 83        <table id="zend.barcode.objects.common.options.table">
 84            <title>Gemeinsame Optionen</title>
 85
 86            <tgroup cols="4">
 87                <thead>
 88                    <row>
 89                        <entry>Option</entry>
 90                        <entry>Daten Typ</entry>
 91                        <entry>Standardwert</entry>
 92                        <entry>Beschreibung</entry>
 93                    </row>
 94                </thead>
 95
 96                <tbody>
 97                    <row>
 98                        <entry><emphasis>barcodeNamespace</emphasis></entry>
 99                        <entry><type>String</type></entry>
100                        <entry><classname>Zend_Barcode_Object</classname></entry>
101
102                        <entry>
103                            Namespace des Renderers; zum Beispiel wenn man den Renderer erweitern
104                            muss
105                        </entry>
106                    </row>
107
108                    <row>
109                        <entry><emphasis>barHeight</emphasis></entry>
110                        <entry><type>Integer</type></entry>
111                        <entry>50</entry>
112                        <entry>Höhe der Balken</entry>
113                    </row>
114                    <row>
115                        <entry><emphasis>barThickWidth</emphasis></entry>
116                        <entry><type>Integer</type></entry>
117                        <entry>3</entry>
118                        <entry>Breite des dicken Balken</entry>
119                    </row>
120
121                    <row>
122                        <entry><emphasis>barThinWidth</emphasis></entry>
123                        <entry><type>Integer</type></entry>
124                        <entry>1</entry>
125                        <entry>Breite des dünnen Balkens</entry>
126                    </row>
127
128                    <row>
129                        <entry><emphasis>factor</emphasis></entry>
130                        <entry><type>Integer</type></entry>
131                        <entry>1</entry>
132
133                        <entry>
134                            Faktor mit dem die Balkenbreiten und Schriftgrößen multipliziert werden
135                        </entry>
136                    </row>
137
138                    <row>
139                        <entry><emphasis>foreColor</emphasis></entry>
140                        <entry><type>Integer</type></entry>
141                        <entry>0 (schwarz)</entry>
142
143                        <entry>
144                            Farbe des Balken und des Textes. Könnte als Integer oder als
145                            <acronym>HTML</acronym> Wert übergeben werden (z.B. "#333333")
146                        </entry>
147                    </row>
148
149                    <row>
150                        <entry><emphasis>backgroundColor</emphasis></entry>
151                        <entry><type>Integer</type> oder <type>String</type></entry>
152                        <entry>16777125 (white)</entry>
153
154                        <entry>
155                            Farbe des Hintergrundes. Könnte als Integer oder als
156                            <acronym>HTML</acronym> Wert übergeben werden (z.B. "#333333")
157                        </entry>
158                    </row>
159
160                    <row>
161                        <entry><emphasis>reverseColor</emphasis></entry>
162                        <entry><type>Boolean</type></entry>
163                        <entry><constant>FALSE</constant></entry>
164
165                        <entry>
166                            Erlaubt die Änderung der Farbe des Balken und des Hintergrunds
167                        </entry>
168                    </row>
169
170                    <row>
171                        <entry><emphasis>orientation</emphasis></entry>
172                        <entry><type>Integer</type></entry>
173                        <entry>0</entry>
174                        <entry>Orientierung des Barcodes</entry>
175                    </row>
176
177                    <row>
178                        <entry><emphasis>font</emphasis></entry>
179                        <entry><type>String</type> oder <type>Integer</type></entry>
180                        <entry><constant>NULL</constant></entry>
181
182                        <entry>
183                            Pfad zu einer <acronym>TTF</acronym> Schriftart oder eine Zahl zwischen
184                            1 und 5 wenn die Bilderstellung mit GD verwendet wird (interne
185                            Schriftarten)
186                        </entry>
187                    </row>
188
189                    <row>
190                        <entry><emphasis>fontSize</emphasis></entry>
191                        <entry><type>Integer</type></entry>
192                        <entry>10</entry>
193
194                        <entry>
195                            Größe der Schriftart (nicht anwendbar bei nummerischen Schriftarten)
196                        </entry>
197                    </row>
198
199                    <row>
200                        <entry><emphasis>withBorder</emphasis></entry>
201                        <entry><type>Boolean</type></entry>
202                        <entry><constant>FALSE</constant></entry>
203                        <entry>Zeichnet einen Rahmen um den Barcode und die Randzonen</entry>
204                    </row>
205
206                    <row>
207                        <entry><emphasis>withQuietZones</emphasis></entry>
208                        <entry><type>Boolean</type></entry>
209                        <entry><constant>TRUE</constant></entry>
210                        <entry>Lässt die Leerzone vor und nach dem Barcode weg</entry>
211                    </row>
212
213                    <row>
214                        <entry><emphasis>drawText</emphasis></entry>
215                        <entry><type>Boolean</type></entry>
216                        <entry><constant>TRUE</constant></entry>
217                        <entry>Setzt ob der Text unter dem Barcode angezeigt wird</entry>
218                    </row>
219
220                    <row>
221                        <entry><emphasis>stretchText</emphasis></entry>
222                        <entry><type>Boolean</type></entry>
223                        <entry><constant>FALSE</constant></entry>
224
225                        <entry>
226                            Spezifiziert ob der Text entlang des kompletten Barcodes gestreckt
227                            werden soll
228                        </entry>
229                    </row>
230
231                    <row>
232                        <entry><emphasis>withChecksum</emphasis></entry>
233                        <entry><type>Boolean</type></entry>
234                        <entry><constant>FALSE</constant></entry>
235
236                        <entry>
237                            Zeigt ob die Checksumme dem Barcode automatisch hinzugefügt wird oder
238                            nicht
239                        </entry>
240                    </row>
241
242                    <row>
243                        <entry><emphasis>withChecksumInText</emphasis></entry>
244                        <entry><type>Boolean</type></entry>
245                        <entry><constant>FALSE</constant></entry>
246
247                        <entry>
248                            Zeigt ob die Checksumme in der textuellen Repräsentation angezeigt wird
249                            oder nicht
250                        </entry>
251                    </row>
252
253                    <row>
254                        <entry><emphasis>text</emphasis></entry>
255                        <entry><type>String</type></entry>
256                        <entry><constant>NULL</constant></entry>
257                        <entry>Der Text der repräsentiert wird, als Barcode</entry>
258                    </row>
259                </tbody>
260            </tgroup>
261        </table>
262
263        <sect3 id="zend.barcode.objects.common.options.barcodefont">
264            <title>Spezieller Fall der statischen setBarcodeFont()</title>
265
266            <para>
267                Man kann eine gemeinsame Schriftart für alle eigenen Objekte setzen indem die
268                statische Methode <methodname>Zend_Barcode_Object::setBarcodeFont()</methodname>
269                verwendet wird. Dieser Wert wird von individuellen Objekten immer überschrieben
270                wenn die <methodname>setFont()</methodname> Methode verwendet wird.
271            </para>
272
273            <programlisting language="php"><![CDATA[
274// In der eigenen Bootstrap Datei:
275Zend_Barcode_Object::setBarcodeFont('my_font.ttf');
276
277// Später im eigenen Code:
278Zend_Barcode::render(
279    'code39',
280    'pdf',
281    array('text' => 'ZEND-FRAMEWORK')
282); // will use 'my_font.ttf'
283
284// oder:
285Zend_Barcode::render(
286    'code39',
287    'image',
288    array(
289        'text' => 'ZEND-FRAMEWORK',
290        'font' => 3
291    )
292); // will use the 3rd GD internal font
293]]></programlisting>
294        </sect3>
295    </sect2>
296
297    <sect2 id="zend.barcode.objects.common.getters">
298        <title>Gemeinsame zusätzliche Getter</title>
299
300        <para></para>
301
302        <table id="zend.barcode.objects.common.getters.table">
303            <title>Gemeinsame Getter</title>
304
305            <tgroup cols="3">
306                <thead>
307                    <row>
308                        <entry>Getter</entry>
309                        <entry>Daten Typ</entry>
310                        <entry>Beschreibung</entry>
311                    </row>
312                </thead>
313
314                <tbody>
315                    <row>
316                        <entry><methodname>getType()</methodname></entry>
317                        <entry><type>String</type></entry>
318
319                        <entry>
320                            Gibt den Namen der Barcode Klasse ohne den Namespace zurück (z.B.
321                            gibt <classname>Zend_Barcode_Object_Code39</classname> einfach
322                            "code39" zurück)
323                        </entry>
324                    </row>
325
326                    <row>
327                        <entry><methodname>getRawText()</methodname></entry>
328                        <entry><type>String</type></entry>
329
330                        <entry>
331                            Gibt den originalen Text zurück der beim Objekt angegeben wurde
332                        </entry>
333                    </row>
334
335                    <row>
336                        <entry><methodname>getTextToDisplay()</methodname></entry>
337                        <entry><type>String</type></entry>
338
339                        <entry>
340                            Gibt den Text zurück welche angezeigt wird, inklusive, wenn aktiviert,
341                            den Wert der Checksumme
342                        </entry>
343                    </row>
344
345                    <row>
346                        <entry><methodname>getQuietZone()</methodname></entry>
347                        <entry><type>Integer</type></entry>
348
349                        <entry>
350                            Gibt die Größe des Raumes an der vor und nach dem Barcode benötigt wird
351                            und keine Zeichnung enthält
352                        </entry>
353                    </row>
354
355                    <row>
356                        <entry><methodname>getInstructions()</methodname></entry>
357                        <entry><type>Array</type></entry>
358                        <entry>Gibt die Zeichenanweisungen als Array zurück.</entry>
359                    </row>
360
361                    <row>
362                        <entry><methodname>getHeight($recalculate = false)</methodname></entry>
363                        <entry><type>Integer</type></entry>
364
365                        <entry>
366                            Gibt die Höhe des Barcodes berechnet nach einer möglichen Rotation
367                            zurück
368                        </entry>
369                    </row>
370
371                    <row>
372                        <entry><methodname>getWidth($recalculate = false)</methodname></entry>
373                        <entry><type>Integer</type></entry>
374
375                        <entry>
376                            Gibt den Wert des Barcodes berechnet nach einer möglichen Rotation
377                            zurück
378                        </entry>
379                    </row>
380
381                    <row>
382                        <entry><methodname>getOffsetTop($recalculate = false)</methodname></entry>
383                        <entry><type>Integer</type></entry>
384
385                        <entry>
386                            Gibt die oberste Position des Barcodes berechnet nach einer möglichen
387                            Rotation zurück
388                        </entry>
389                    </row>
390
391                    <row>
392                        <entry><methodname>getOffsetLeft($recalculate = false)</methodname></entry>
393                        <entry><type>Integer</type></entry>
394
395                        <entry>
396                            Gibt die linke Position des Barcodes berechnet nach einer möglichen
397                            Rotation zurück
398                        </entry>
399                    </row>
400                </tbody>
401            </tgroup>
402        </table>
403    </sect2>
404
405    <xi:include href="Zend_Barcode-Objects_Details.xml" />
406</sect1>