Zend_Barcode-Renderers.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.barcode.renderers">
  5. <title>Renderizadores do Zend_Barcode</title>
  6. <para>
  7. Os renderizadores tem algumas opções em comum. Essas opções podem ser definidas em
  8. quatro formas:
  9. </para>
  10. <itemizedlist>
  11. <listitem>
  12. <para>
  13. Como uma matriz ou um objeto <classname>Zend_Config</classname> passado ao
  14. construtor.
  15. </para>
  16. </listitem>
  17. <listitem>
  18. <para>
  19. Como uma matriz passada ao método <methodname>setOptions()</methodname>.
  20. </para>
  21. </listitem>
  22. <listitem>
  23. <para>
  24. Como um objeto <classname>Zend_Config</classname> passado ao método
  25. <methodname>setConfig()</methodname>.
  26. </para>
  27. </listitem>
  28. <listitem>
  29. <para>Como valores distintos passados à setters individuais.</para>
  30. </listitem>
  31. </itemizedlist>
  32. <example id="zend.barcode.renderers.configuration">
  33. <title>Diferentes maneiras de parametrizar um objeto renderizador</title>
  34. <programlisting language="php"><![CDATA[
  35. $options = array('topOffset' => 10);
  36. // Caso 1
  37. $renderer = new Zend_Barcode_Renderer_Pdf($options);
  38. // Caso 2
  39. $renderer = new Zend_Barcode_Renderer_Pdf();
  40. $renderer->setOptions($options);
  41. // Caso 3
  42. $config = new Zend_Config($options);
  43. $renderer = new Zend_Barcode_Renderer_Pdf();
  44. $renderer->setConfig($config);
  45. // Caso 4
  46. $renderer = new Zend_Barcode_Renderer_Pdf();
  47. $renderer->setTopOffset(10);
  48. ]]></programlisting>
  49. </example>
  50. <sect2 id="zend.barcode.renderers.common.options">
  51. <title>Opções Comuns</title>
  52. <para>
  53. Na lista seguinte, os valores não têm unidades; usaremos o termo "unidade". Por exemplo,
  54. o valor padrão da "barra fina" é "1 unidade". As unidades reais dependem do suporte de
  55. renderização. Os setters individuais são obtidos mudando a letra inicial da opção para
  56. maiúscula e colocando o prefixo "set" (por exemplo "barHeight" => "setBarHeight").
  57. Todas as opções têm um getter correspondente com prefixo "get" (por exemplo
  58. "getBarHeight"). As opções disponíveis são:
  59. </para>
  60. <table id="zend.barcode.renderers.common.options.table">
  61. <title>Opções Comuns</title>
  62. <tgroup cols="4">
  63. <thead>
  64. <row>
  65. <entry>Opção</entry>
  66. <entry>Tipo de Dado</entry>
  67. <entry>Valor Padrão</entry>
  68. <entry>Descrição</entry>
  69. </row>
  70. </thead>
  71. <tbody>
  72. <row>
  73. <entry><emphasis>rendererNamespace</emphasis></entry>
  74. <entry><type>String</type></entry>
  75. <entry><classname>Zend_Barcode_Renderer</classname></entry>
  76. <entry>
  77. Namespace do renderizador; por exemplo, caso precise estender os
  78. renderizadores.
  79. </entry>
  80. </row>
  81. <row>
  82. <entry><emphasis>horizontalPosition</emphasis></entry>
  83. <entry><type>String</type></entry>
  84. <entry>"left"</entry>
  85. <entry>
  86. Pode ser "left", "center" ou "right". Pode ser útil com o formato
  87. <acronym>PDF</acronym> ou se o método
  88. <methodname>setWidth()</methodname> for usado com um
  89. renderizador de imagem.
  90. </entry>
  91. </row>
  92. <row>
  93. <entry><emphasis>verticalPosition</emphasis></entry>
  94. <entry><type>String</type></entry>
  95. <entry>"top"</entry>
  96. <entry>
  97. Pode ser "top", "middle" ou "bottom". Pode ser útil com o formato
  98. <acronym>PDF</acronym> ou se o método
  99. <methodname>setHeight()</methodname> for usado com um
  100. renderizador de imagem.
  101. </entry>
  102. </row>
  103. <row>
  104. <entry><emphasis>leftOffset</emphasis></entry>
  105. <entry><type>Integer</type></entry>
  106. <entry>0</entry>
  107. <entry>
  108. Posição superior do código de barras no interior do renderizador. Se
  109. usado, este valor substituirá a opção "horizontalPosition".
  110. </entry>
  111. </row>
  112. <row>
  113. <entry><emphasis>topOffset</emphasis></entry>
  114. <entry><type>Integer</type></entry>
  115. <entry>0</entry>
  116. <entry>
  117. Posição superior do código de barras no interior do renderizador. Se
  118. usado, este valor substituirá a opção "verticalPosition".
  119. </entry>
  120. </row>
  121. <row>
  122. <entry><emphasis>automaticRenderError</emphasis></entry>
  123. <entry><type>Boolean</type></entry>
  124. <entry><constant>TRUE</constant></entry>
  125. <entry>
  126. Ativa a renderização automática dos erros. Se ocorrer uma exceção, o
  127. objeto código de barras fornecido será substituído por uma representação
  128. de erro. Observe que alguns erros (ou exceções) não podem ser
  129. renderizados.
  130. </entry>
  131. </row>
  132. <row>
  133. <entry><emphasis>moduleSize</emphasis></entry>
  134. <entry><type>Float</type></entry>
  135. <entry>1</entry>
  136. <entry>Tamanho de um módulo de renderização no suporte.</entry>
  137. </row>
  138. <row>
  139. <entry><emphasis>barcode</emphasis></entry>
  140. <entry><classname>Zend_Barcode_Object</classname></entry>
  141. <entry><constant>NULL</constant></entry>
  142. <entry>O objeto código de barras a ser renderizado.</entry>
  143. </row>
  144. </tbody>
  145. </tgroup>
  146. </table>
  147. <para>
  148. Existe um getter adicional: <methodname>getType()</methodname>. Ele retorna o nome da
  149. classe de renderização sem o namespace (por exemplo,
  150. <classname>Zend_Barcode_Renderer_Image</classname> retorna "image").
  151. </para>
  152. </sect2>
  153. <sect2 id="zend.barcode.renderers.image">
  154. <title>Zend_Barcode_Renderer_Image</title>
  155. <para>
  156. O renderizador Image irá desenhar a lista de instruções do objeto código de barras em
  157. um recurso de imagem. O componente requer a extensão GD. A largura padrão de um módulo
  158. é de 1 pixel.
  159. </para>
  160. <para>As opções disponíveis são:</para>
  161. <table id="zend.barcode.renderers.image.table">
  162. <title>Opções do Zend_Barcode_Renderer_Image</title>
  163. <tgroup cols="4">
  164. <thead>
  165. <row>
  166. <entry>Opção</entry>
  167. <entry>Tipo de Dado</entry>
  168. <entry>Valor Padrão</entry>
  169. <entry>Descrição</entry>
  170. </row>
  171. </thead>
  172. <tbody>
  173. <row>
  174. <entry><emphasis>height</emphasis></entry>
  175. <entry><type>Integer</type></entry>
  176. <entry>0</entry>
  177. <entry>
  178. Permite-lhe especificar a altura da imagem resultante. Se for "0", a
  179. altura será calculada pelo objeto código de barras.
  180. </entry>
  181. </row>
  182. <row>
  183. <entry><emphasis>width</emphasis></entry>
  184. <entry><type>Integer</type></entry>
  185. <entry>0</entry>
  186. <entry>
  187. Permite-lhe especificar a largura da imagem resultante. Se for "0", a
  188. largura será calculada pelo objeto código de barras.
  189. </entry>
  190. </row>
  191. <row>
  192. <entry><emphasis>imageType</emphasis></entry>
  193. <entry><type>String</type></entry>
  194. <entry>"png"</entry>
  195. <entry>
  196. Especifica o formato da imagem. Pode ser "png", "jpeg", "jpg" ou "gif".
  197. </entry>
  198. </row>
  199. </tbody>
  200. </tgroup>
  201. </table>
  202. </sect2>
  203. <sect2 id="zend.barcode.renderers.pdf">
  204. <title>Zend_Barcode_Renderer_Pdf</title>
  205. <para>
  206. O renderizador de <acronym>PDF</acronym> irá desenhar a lista de instruções do objeto
  207. código de barras em um documento <acronym>PDF</acronym>. A largura padrão de um módulo
  208. é de 0,5 point.
  209. </para>
  210. <para>
  211. Não existem opções específicas para este renderizador.
  212. </para>
  213. </sect2>
  214. <sect2 id="zend.barcode.renderers.svg">
  215. <title>Zend_Barcode_Renderer_Svg</title>
  216. <para>
  217. O renderizador de <acronym>SVG</acronym> irá desenhar a lista de instruções do objeto
  218. código de barras em um documento <acronym>SVG</acronym>. A largura padrão de um módulo
  219. é de 1 pixel.
  220. </para>
  221. <para>As opções disponíveis são:</para>
  222. <table id="zend.barcode.renderers.svg.table">
  223. <title>Opções do Zend_Barcode_Renderer_Svg</title>
  224. <tgroup cols="4">
  225. <thead>
  226. <row>
  227. <entry>Opção</entry>
  228. <entry>Tipo de Dado</entry>
  229. <entry>Valor Padrão</entry>
  230. <entry>Descrição</entry>
  231. </row>
  232. </thead>
  233. <tbody>
  234. <row>
  235. <entry><emphasis>height</emphasis></entry>
  236. <entry><type>Integer</type></entry>
  237. <entry>0</entry>
  238. <entry>
  239. Permite-lhe especificar a altura da imagem resultante. Se for "0", a
  240. altura será calculada pelo objeto código de barras.
  241. </entry>
  242. </row>
  243. <row>
  244. <entry><emphasis>width</emphasis></entry>
  245. <entry><type>Integer</type></entry>
  246. <entry>0</entry>
  247. <entry>
  248. Permite-lhe especificar a largura da imagem resultante. Se for "0", a
  249. largura será calculada pelo objeto código de barras.
  250. </entry>
  251. </row>
  252. </tbody>
  253. </tgroup>
  254. </table>
  255. </sect2>
  256. </sect1>