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