2
0

Zend_Form-Forms.xml 73 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15103 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.form.forms">
  5. <title>Creando formularios usando Zend_Form</title>
  6. <para>
  7. La clase <classname>Zend_Form</classname> es usada para agregar elementos de
  8. formulario, desplegar grupos y subformularios. Éstos pueden ejecutar las
  9. siguientes acciones en estos elementos:
  10. </para>
  11. <itemizedlist>
  12. <listitem><para>
  13. Validación, incluyendo la recuperación de código y mensajes de error
  14. </para></listitem>
  15. <listitem><para>
  16. Agregación de valor, incluyendo el llenado de elementos y recuperación
  17. de valores tanto filtrados como no filtrados para todos los elementos
  18. </para></listitem>
  19. <listitem><para>
  20. Iteración sobre todos los elementos, en el orden en el cual han sido
  21. introducidos o basados en el orden recuperado de cada elemento
  22. </para></listitem>
  23. <listitem><para>
  24. Generando el formulario entero, ya sea por un simple decorador que
  25. ejecuta un muestreo personalizado o por iteración sobre cada
  26. elemento del formulario
  27. </para></listitem>
  28. </itemizedlist>
  29. <para>
  30. Mientras los formularios creados con <classname>Zend_Form</classname> pueden ser
  31. complejos, probablemente su mejor uso es para formularios simples; es
  32. mejor utilizarlo para desarrollar aplicaciones rápidas (RAD) y de prototipado.
  33. </para>
  34. <para>
  35. En lo más básico, simplemente instancie el objeto formulario:
  36. </para>
  37. <programlisting role="php"><![CDATA[
  38. // Objeto form genérico:
  39. $form = new Zend_Form();
  40. // Objeto form personalizado:
  41. $form = new My_Form()
  42. ]]></programlisting>
  43. <para>
  44. Opcionalmente puede pasarlo en la configuración, la cual será usada para
  45. establecer el estado del objeto, potencialmente así como también crear
  46. nuevos elementos:
  47. </para>
  48. <programlisting role="php"><![CDATA[
  49. // Pasando opciones en la configuración:
  50. $form = new Zend_Form($config);
  51. ]]></programlisting>
  52. <para>
  53. <classname>Zend_Form</classname> es iterable, e iterará sobre elementos, grupos que
  54. mostrar y subformularios, usando el orden en el cual han sido registrados
  55. y en cualquier índice de orden que cada uno pueda tener. Esto es útil
  56. en casos donde desee generar los elementos manualmente en el orden apropiado.
  57. </para>
  58. <para>
  59. La magia de <classname>Zend_Form</classname> radica en la habilidad para servir como
  60. fábrica para elementos y grupos, así como también la habilidad de generarse
  61. a sí mismo a través de decoradores.
  62. </para>
  63. <sect2 id="zend.form.forms.plugins">
  64. <title>Cargadores de Plugin</title>
  65. <para>
  66. <classname>Zend_Form</classname> hace uso de
  67. <classname>Zend_Loader_PluginLoader</classname> para permitir a los
  68. desarroladores especificar la ubicación de elementos y decoradores
  69. alternativos. Cada uno tiene su propio plugin loader asociado, y
  70. métodos de acceso genéricos son usados para recuperar y modificar
  71. cada uno.
  72. </para>
  73. <para>
  74. Los siguientes tipos de cargadores son usados con los variados métodos
  75. del plugin loader: 'element' y 'decorator'. Los nombres de los tipos
  76. no distinguen mayúsculas de minúsculas.
  77. </para>
  78. <para>
  79. Los métodos usados para interactuar con plugin loaders son los siguientes:
  80. </para>
  81. <itemizedlist>
  82. <listitem><para>
  83. <code>setPluginLoader($loader, $type)</code>: $loader es el propio
  84. objeto plugin loader, mientras $type es uno de los tipos
  85. especificados arriba. Esto establece el plugin loader para el
  86. tipo dado al objeto loader recién especificado.
  87. </para></listitem>
  88. <listitem><para>
  89. <code>getPluginLoader($type)</code>: recupera el plugin loader
  90. asociado con $type.
  91. </para></listitem>
  92. <listitem><para>
  93. <code>addPrefixPath($prefix, $path, $type = null)</code>: agrega
  94. una asociación prefijo/ruta al loader especificado por $type. Si
  95. $type es nulo, intentará añadir una ruta a todos los loaders,
  96. añadiendo el prefijo "_Element" y "_Decorator"; y añadiendo la
  97. ruta con "Element/" y "Decorator/". Si tiene todas sus clases
  98. form element extras bajo una jerarquía común, éste es un método
  99. coveniente para establecer el prefijo de base para ellas.
  100. </para></listitem>
  101. <listitem><para>
  102. <code>addPrefixPaths(array $spec)</code>: le permite añadir varias
  103. rutas en uno o mas plugin loaders. Se espera que cada elemento
  104. del array sea un array con las claves 'path', 'prefix' y 'type'.
  105. </para></listitem>
  106. </itemizedlist>
  107. <para>
  108. Adicionalmente, puede especificar prefijos de rutas para todos los
  109. elementos y mostrar grupos creados a través de una instancia de
  110. <classname>Zend_Form</classname> usando los siguientes métodos:
  111. </para>
  112. <itemizedlist>
  113. <listitem><para>
  114. <code>addElementPrefixPath($prefix, $path, $type = null)</code>:
  115. Igual que <code>addPrefixPath()</code>, debe especificar un
  116. prefijo y ruta de clase. <code>$type</code>, cuando se especifica,
  117. tiene que ser uno de los tipos plugin loader especificados por
  118. <classname>Zend_Form_Element</classname>; vea la <link
  119. linkend="zend.form.elements.loaders">sección elemento plugins
  120. </link> para más información de valores válidos para
  121. <code>$type</code>. Si <code>$type</code> no es especificado, el
  122. método asumirá que es un prefijo general para todos los tipos.
  123. </para></listitem>
  124. <listitem><para>
  125. <code>addDisplayGroupPrefixPath($prefix, $path)</code>:
  126. Igual que <code>addPrefixPath()</code>, debe especificar un
  127. prefijo y ruta de clase; sin embargo, dado que los grupos de visualización (display groups)
  128. sólo soportan decoradores como plugins, <code>$type</code> no es
  129. necesario.
  130. </para></listitem>
  131. </itemizedlist>
  132. <para>
  133. Elementos y decoradores personalizados son una manera fácil de compartir
  134. funcionalidad entre formularios y encapsular funcionalidad personalizada.
  135. Vea el <link
  136. linkend="zend.form.elements.loaders.customLabel">ejemplo de Etiqueta
  137. Personalizada</link> en la documentación de elementos para un
  138. ejemplo de cómo elementos personalizados pueden ser usados como
  139. reemplazos para clases estándar.
  140. </para>
  141. </sect2>
  142. <sect2 id="zend.form.forms.elements">
  143. <title>Elementos</title>
  144. <para>
  145. <classname>Zend_Form</classname> proporciona varios métodos de acceso para añadir
  146. y eliminar elementos de el formulario. Éstos pueden tomar instancias
  147. de objetos de elemento o servir como fábricas para instanciar el
  148. objeto elemento a sí mismo.
  149. </para>
  150. <para>
  151. El método más básico para añadir un elemento es
  152. <code>addElement()</code>. Este método puede tomar también un objeto
  153. de tipo <classname>Zend_Form_Element</classname> (o de una clase extendiendo
  154. <classname>Zend_Form_Element</classname>), o argumentos para construir un nuevo
  155. elemento -- incluyendo el elemento tipo, nombre y algunas opciones de
  156. configuración.
  157. </para>
  158. <para>
  159. Como algunos ejemplos:
  160. </para>
  161. <programlisting role="php"><![CDATA[
  162. // Usando un elemento instanciado:
  163. $element = new Zend_Form_Element_Text('foo');
  164. $form->addElement($element);
  165. // Usando una fábrica
  166. //
  167. // Crea un elemento de tipo Zend_Form_Element_Text con el
  168. // nombre de 'foo':
  169. $form->addElement('text', 'foo');
  170. // Pasa una opción etiqueta al elemento:
  171. $form->addElement('text', 'foo', array('label' => 'Foo:'));
  172. ]]></programlisting>
  173. <note>
  174. <title>addElement() Implementa una Interfaz Fluida</title>
  175. <para>
  176. <code>addElement()</code> implementa una interfaz fluida; es
  177. decir, retorna el objeto <classname>Zend_Form</classname> y no un
  178. elemento. Esto se ha hecho para permitirle encadenar
  179. multiples métodos addElement() u otros métodos formulario que
  180. implementen una interfaz fluida (todos los establecedores en Zend_Form
  181. implementan el patrón).
  182. </para>
  183. <para>
  184. Si desea retornar el elemento, use
  185. <code>createElement()</code>, el cual es esbozado abajo. Tenga en cuenta
  186. de cualquier manera que <code>createElement()</code> no adjunta el
  187. elemento al formulario.
  188. </para>
  189. <para>
  190. Internamente, <code>addElement()</code> en realidad emplea
  191. <code>createElement()</code> para crear el elemento antes de
  192. adjuntarlo al formulario.
  193. </para>
  194. </note>
  195. <para>
  196. Una vez que el elemento ha sido añadido al formulario, puede recuperarlo por
  197. el nombre. Puede también finalizar usando el método <code>getElement()</code>
  198. o usando sobrecarga para acceder al elemento como una propiedad de
  199. objeto:
  200. </para>
  201. <programlisting role="php"><![CDATA[
  202. // getElement():
  203. $foo = $form->getElement('foo');
  204. // Como propiedad del objeto:
  205. $foo = $form->foo;
  206. ]]></programlisting>
  207. <para>
  208. Ocasionalmente, se quiere crear un elemento sin adjuntarlo
  209. al formulario (para instanciar, si se desea hacer uso de las
  210. rutas de plugin introducidas con el formulario, pero después se desea adjuntar el
  211. objeto al subformulario). El método <code>createElement()</code>
  212. permite hacer eso:
  213. </para>
  214. <programlisting role="php"><![CDATA[
  215. // $username llega a ser un objeto Zend_Form_Element_Text:
  216. $username = $form->createElement('text', 'username');
  217. ]]></programlisting>
  218. <sect3 id="zend.form.forms.elements.values">
  219. <title>Llenar y recuperar valores</title>
  220. <para>
  221. Después de validar el formulario, originalmente se necesitará recuperar los
  222. valores para poder ejecutar otras operaciones, tal como actualizar una
  223. base de datos o notificar un servicio web. Se pueden recuperar todos los valores
  224. para todos los elementos usando <code>getValues()</code>;
  225. <code>getValue($name)</code> le permite recuperar un solo
  226. valor del elemento por su nombre:
  227. </para>
  228. <programlisting role="php"><![CDATA[
  229. // Obtener todos los valores:
  230. $values = $form->getValues();
  231. // Obtener sólo los valores del elemento 'foo':
  232. $value = $form->getValue('foo');
  233. ]]></programlisting>
  234. <para>
  235. A veces se quiere llenar el formulario con valores especificos
  236. antes de generarlos. Éstos pueden ser llevados a cabo ya sea con los
  237. métodos <code>setDefaults()</code> o <code>populate()</code>:
  238. </para>
  239. <programlisting role="php"><![CDATA[
  240. $form->setDefaults($data);
  241. $form->populate($data);
  242. ]]></programlisting>
  243. <para>
  244. Por otro lado, si se quisera limpiar el formulario antes de llenarlo
  245. o validarlo; se puede realizar usando el
  246. método <code>reset()</code>:
  247. </para>
  248. <programlisting role="php"><![CDATA[
  249. $form->reset();
  250. ]]></programlisting>
  251. </sect3>
  252. <sect3 id="zend.form.forms.elements.global">
  253. <title>Operaciones Globales</title>
  254. <para>
  255. Ocasionalemnte se necesitarán ciertas operaciones que afecten a todos
  256. los elementos. Escenarios comunes incluyen la necesidad de determinar rutas de acceso
  257. al prefijo complemento para todos los elementos, determinando decoradores para todos los elementos y
  258. determinando filtros para todos los elementos. Como ejemplos:
  259. </para>
  260. <example id="zend.form.forms.elements.global.allpaths">
  261. <title>Determinando rutas de acceso de prefijos para todos los elementos</title>
  262. <para>
  263. Se puede determinar rutas de acceso para prefijos para todos los elementos por tipo,
  264. o usando un prefijo global. Como ejemplos:
  265. </para>
  266. <programlisting role="php"><![CDATA[
  267. // Determinar la ruta de acceso de prefijos global
  268. // Crear rutas de acceso para los prefijos My_Foo_Filter, My_Foo_Validate,
  269. // y My_Foo_Decorator
  270. $form->addElementPrefixPath('My_Foo', 'My/Foo/');
  271. // Sólo rutas de acceso de filtros:
  272. $form->addElementPrefixPath('My_Foo_Filter',
  273. 'My/Foo/Filter',
  274. 'filter');
  275. // Sólo rutas de acceso de validadores:
  276. $form->addElementPrefixPath('My_Foo_Validate',
  277. 'My/Foo/Validate',
  278. 'validate');
  279. // Sólo rutas de acceso de decoradores:
  280. $form->addElementPrefixPath('My_Foo_Decorator',
  281. 'My/Foo/Decorator',
  282. 'decorator');
  283. ]]></programlisting>
  284. </example>
  285. <example id="zend.form.forms.elements.global.decorators">
  286. <title>Determinando Decoradores para todos los elementos</title>
  287. <para>
  288. Se pueden determinar decoradores para todos los elementos.
  289. <code>setElementDecorators()</code> acepta una matriz de
  290. decoradores, solo como <code>setDecorators()</code>, y
  291. reescribirá cualquier decorador previamente determinado en cada elemento. En
  292. este ejemplo, determinamos los decoradores para simplificar una ViewHelper
  293. y una Label:
  294. </para>
  295. <programlisting role="php"><![CDATA[
  296. $form->setElementDecorators(array(
  297. 'ViewHelper',
  298. 'Label'
  299. ));
  300. ]]></programlisting>
  301. </example>
  302. <example id="zend.form.forms.elements.global.decoratorsFilter">
  303. <title>Determinando decoradores para algunos elementos</title>
  304. <para>
  305. Pueden determinarse también decoradores para un subconjunto de elementos,
  306. ya sea por inclusión o exclusión. El segundo argumento
  307. <code>setElementDecorators()</code> puede ser un array de
  308. nombres de elemento; por defecto, especificar un array de ese tipo
  309. determinará los decoradores especificados en esos elementos solamente. Puede
  310. tambien pasar un tercer elemento, una bandera indicando si
  311. esta lista de elementos es para propósitos de inclusión o exclusión;
  312. si es falso, decorará todos los elementos
  313. <emphasis>excepto</emphasis> los pasados en la lista,
  314. Como uso estándar del método, cualquier decorador pasado
  315. reescribirá cualquier decorador previamente determinado en cada
  316. elemento.
  317. </para>
  318. <para>
  319. En el siguiente fragmento, indicamos que queremos los decoradores
  320. ViewHelper y Label para los elementos
  321. 'foo' y 'bar':
  322. </para>
  323. <programlisting role="php"><![CDATA[
  324. $form->setElementDecorators(
  325. array(
  326. 'ViewHelper',
  327. 'Label'
  328. ),
  329. array(
  330. 'foo',
  331. 'bar'
  332. )
  333. );
  334. ]]></programlisting>
  335. <para>
  336. Por otro lado, con este fragmento, indicaremos
  337. que queremos usar solamente los decoradores
  338. ViewHelper y Label para cada elemento <emphasis>excepto</emphasis>
  339. los elementos 'foo' y 'bar':
  340. </para>
  341. <programlisting role="php"><![CDATA[
  342. $form->setElementDecorators(
  343. array(
  344. 'ViewHelper',
  345. 'Label'
  346. ),
  347. array(
  348. 'foo',
  349. 'bar'
  350. ),
  351. false
  352. );
  353. ]]></programlisting>
  354. </example>
  355. <note>
  356. <title>Algunos Decoradores son Inapropiados para algunos Elementos</title>
  357. <para>
  358. Mientras <code>setElementDecorators()</code> puede parecer
  359. una buena solución, existen algunos casos donde puede
  360. terminar con resultados inesperados, Por ejemplo,
  361. los muchos elementos botones (Submit, Button, Reset),
  362. actualmente usan la etiqueta como el valor del botón
  363. y sólo usan los decoradores ViewHelper y DtDdWrapper --
  364. previniendo una etiqueta adicional, errores, y sugerencias de
  365. ser generadas; el ejemplo de arriba podría duplicar algún
  366. contenido (la etiqueta).
  367. </para>
  368. <para>
  369. Se puede usar el array de inclusión/exclusión para superar
  370. este problema como se ha notado en el ejemplo anterior.
  371. </para>
  372. <para>
  373. Entonces, use este método sabiamente y dése cuenta de que puede
  374. necesitar excluir o cambiar manualmente algunos elementos decoradores
  375. para prevenir una salida no deseada.
  376. </para>
  377. </note>
  378. <example id="zend.form.forms.elements.global.filters">
  379. <title>Determinando Filtros para todos los Elementos</title>
  380. <para>
  381. En muchos casos, puede quererse aplicar el mismo filtro a todos
  382. los elementos; un caso común es <code>trim()</code> a todos los valores:
  383. </para>
  384. <programlisting role="php"><![CDATA[
  385. $form->setElementFilters(array('StringTrim'));
  386. ]]></programlisting>
  387. </example>
  388. </sect3>
  389. <sect3 id="zend.form.forms.elements.methods">
  390. <title>Métodos para Interactuar con los Elementos</title>
  391. <para>
  392. Los siguientes métodos pueden ser usados para interactuar con los elementos:
  393. </para>
  394. <itemizedlist>
  395. <listitem><para>
  396. <code>createElement($element, $name = null, $options = null)</code>
  397. </para></listitem>
  398. <listitem><para>
  399. <code>addElement($element, $name = null, $options = null)</code>
  400. </para></listitem>
  401. <listitem><para>
  402. <code>addElements(array $elements)</code>
  403. </para></listitem>
  404. <listitem><para>
  405. <code>setElements(array $elements)</code>
  406. </para></listitem>
  407. <listitem><para>
  408. <code>getElement($name)</code>
  409. </para></listitem>
  410. <listitem><para>
  411. <code>getElements()</code>
  412. </para></listitem>
  413. <listitem><para>
  414. <code>removeElement($name)</code>
  415. </para></listitem>
  416. <listitem><para>
  417. <code>clearElements()</code>
  418. </para></listitem>
  419. <listitem><para>
  420. <code>setDefaults(array $defaults)</code>
  421. </para></listitem>
  422. <listitem><para>
  423. <code>setDefault($name, $value)</code>
  424. </para></listitem>
  425. <listitem><para>
  426. <code>getValue($name)</code>
  427. </para></listitem>
  428. <listitem><para>
  429. <code>getValues()</code>
  430. </para></listitem>
  431. <listitem><para>
  432. <code>getUnfilteredValue($name)</code>
  433. </para></listitem>
  434. <listitem><para>
  435. <code>getUnfilteredValues()</code>
  436. </para></listitem>
  437. <listitem><para>
  438. <code>setElementFilters(array $filters)</code>
  439. </para></listitem>
  440. <listitem><para>
  441. <code>setElementDecorators(array $decorators)</code>
  442. </para></listitem>
  443. <listitem><para>
  444. <code>addElementPrefixPath($prefix, $path, $type = null)</code>
  445. </para></listitem>
  446. <listitem><para>
  447. <code>addElementPrefixPaths(array $spec)</code>
  448. </para></listitem>
  449. </itemizedlist>
  450. </sect3>
  451. </sect2>
  452. <sect2 id="zend.form.forms.displaygroups">
  453. <title>Grupos de visualización (display groups)</title>
  454. <para>
  455. Los grupos de visualización (display groups) son una manera de crear grupos virtuales de elementos para
  456. propósitos de visualización. Todos los elementos quedan accesibles por nombre en el
  457. formulario, pero cuando interactúan o se ejecutan sobre el formulario, cualquiera de los elementos en
  458. un grupos de visualización son generados juntos. El caso más común de uso es
  459. agrupando los elementos en fieldsets. (TODO)
  460. </para>
  461. <para>
  462. La clase base para los grupos de visualización es
  463. <code>Zend_Form_DisplayGroup</code>. Mientras puede ser instanciado
  464. directamente, es mejor usar el método <code>addDisplayGroup()</code>
  465. de la clase<classname>Zend_Form</classname>. Este método toma un
  466. array de elementos como primer argumento y el nombre para el grupo de
  467. visualización como segundo argumento. Opcionalmente, se puede pasar en una array
  468. de opciones o en un objeto <code>Zend_Config</code> como tercer argumento.
  469. </para>
  470. <para>
  471. Asumiendo que los elementos 'username' y 'password' has sido determinados
  472. en el formulario, el siguiente código podría agrupar estos elementos en un
  473. grupo de visualización 'login':
  474. </para>
  475. <programlisting role="php"><![CDATA[
  476. $form->addDisplayGroup(array('username', 'password'), 'login');
  477. ]]></programlisting>
  478. <para>
  479. Puede acceder a los grupos de visualización usando el
  480. método <code>getDisplayGroup()</code>, o mediante la sobrecarga usando el
  481. nombre del grupo de visualización:
  482. </para>
  483. <programlisting role="php"><![CDATA[
  484. // Usando getDisplayGroup():
  485. $login = $form->getDisplayGroup('login');
  486. // Usando sobrecarga:
  487. $login = $form->login;
  488. ]]></programlisting>
  489. <note>
  490. <title>Decoradores por defecto que no necesitan ser cargados</title>
  491. <para>
  492. Por defecto, los grupos de visualización son cargados durante la
  493. inicialización del objeto. Se puede deshabilitar pasando la
  494. opción 'disableLoadDefaultDecorators' cuando se crea un grupo de visualización:
  495. </para>
  496. <programlisting role="php"><![CDATA[
  497. $form->addDisplayGroup(
  498. array('foo', 'bar'),
  499. 'foobar',
  500. array('disableLoadDefaultDecorators' => true)
  501. );
  502. ]]></programlisting>
  503. <para>
  504. Esta opción puede ser una mezcla con otras opciones pasadas,
  505. ambas como opciones de array o en el objeto <code>Zend_Config</code>
  506. </para>
  507. </note>
  508. <sect3 id="zend.form.forms.displaygroups.global">
  509. <title>Operaciones Globales</title>
  510. <para>
  511. Al igual que los elementos, existen algunas operaciones que
  512. pueden afectar a todos los grupos de visualización; éstas incluyen determinar decoradores
  513. y fijar la ruta de acceso donde buscar los decoradores.
  514. </para>
  515. <example id="zend.form.forms.displaygroups.global.paths">
  516. <title>Fijando el Prefijo de Ruta del Decorador para todos los Grupos de Visualización</title>
  517. <para>
  518. Por defecto, los grupos de visualización heredan cualquier
  519. ruta de decorador que use el formulario; sin embargo, si deberían buscar
  520. en una ruta alternativa, puede usar el método
  521. <code>addDisplayGroupPrefixPath()</code> method.
  522. </para>
  523. <programlisting role="php"><![CDATA[
  524. $form->addDisplayGroupPrefixPath('My_Foo_Decorator', 'My/Foo/Decorator');
  525. ]]></programlisting>
  526. </example>
  527. <example id="zend.form.forms.displaygroups.global.decorators">
  528. <title>Fijando Decoradores para Todos los Grupos de Visualización</title>
  529. <para>
  530. Pueden determinarse decoradores para todos los grupos de visualización,
  531. <code>setDisplayGroupDecorators()</code> admite un array de
  532. decoradores, al igual que <code>setDecorators()</code>, y sobreescribirá
  533. cualquier conjunto de decoradores previo en cada grupo de visualización.
  534. En este ejemplo, fijamos los decoradores a un fieldset (el decorador FormElements
  535. es necesario para asegurar que los elementos son iterador):
  536. </para>
  537. <programlisting role="php"><![CDATA[
  538. $form->setDisplayGroupDecorators(array(
  539. 'FormElements',
  540. 'Fieldset'
  541. ));
  542. ]]></programlisting>
  543. </example>
  544. </sect3>
  545. <sect3 id="zend.form.forms.displaygroups.customClasses">
  546. <title>Usando Clases de Grupos de Visualización Personalizadas</title>
  547. <para>
  548. Por defecto, <classname>Zend_Form</classname> utiliza la clase
  549. <code>Zend_Form_DisplayGroup</code> para grupos de visualización.
  550. Puede ocurrir que necesite extender esta clase con el fin
  551. de obtener una funcionalid personalizada. <code>addDisplayGroup()</code>
  552. no permite pasar una instancia determinada, pero permite especificar
  553. la clase que usar como una de sus opciones, usando la clave
  554. 'displayGroupClass':
  555. </para>
  556. <programlisting role="php"><![CDATA[
  557. // Use the 'My_DisplayGroup' class
  558. $form->addDisplayGroup(
  559. array('username', 'password'),
  560. 'user',
  561. array('displayGroupClass' => 'My_DisplayGroup')
  562. );
  563. ]]></programlisting>
  564. <para>
  565. Si la clase no ha sido todavía cargada, <classname>Zend_Form</classname>
  566. intentará cargarla a través de <code>Zend_Loader</code>.
  567. </para>
  568. <para>
  569. También puede especificar una clase de grupo de visualización por defecto
  570. para usar con el formulario, de forma que todos los grupos de visualización
  571. creados con el objeto formulario usen esa clase:
  572. </para>
  573. <programlisting role="php"><![CDATA[
  574. // Use the 'My_DisplayGroup' class for all display groups:
  575. $form->setDefaultDisplayGroupClass('My_DisplayGroup');
  576. ]]></programlisting>
  577. <para>
  578. Esta funcionalidad puede especificarse en configuraciones como
  579. 'defaultDisplayGroupClass', y será cargada con antelación para
  580. asegurar que todos los grupos de visualización usen esa clase.
  581. </para>
  582. </sect3>
  583. <sect3 id="zend.form.forms.displaygroups.interactionmethods">
  584. <title>Métodos para Interactuar con Grupos de Visualización</title>
  585. <para>
  586. Los siguientes métodos pueden ser usados para interactuar con el grupo de visualización:
  587. </para>
  588. <itemizedlist>
  589. <listitem><para>
  590. <code>addDisplayGroup(array $elements, $name, $options = null)</code>
  591. </para></listitem>
  592. <listitem><para>
  593. <code>addDisplayGroups(array $groups)</code>
  594. </para></listitem>
  595. <listitem><para>
  596. <code>setDisplayGroups(array $groups)</code>
  597. </para></listitem>
  598. <listitem><para>
  599. <code>getDisplayGroup($name)</code>
  600. </para></listitem>
  601. <listitem><para>
  602. <code>getDisplayGroups()</code>
  603. </para></listitem>
  604. <listitem><para>
  605. <code>removeDisplayGroup($name)</code>
  606. </para></listitem>
  607. <listitem><para>
  608. <code>clearDisplayGroups()</code>
  609. </para></listitem>
  610. <listitem><para>
  611. <code>setDisplayGroupDecorators(array $decorators)</code>
  612. </para></listitem>
  613. <listitem><para>
  614. <code>addDisplayGroupPrefixPath($prefix, $path)</code>
  615. </para></listitem>
  616. <listitem><para>
  617. <code>setDefaultDisplayGroupClass($class)</code>
  618. </para></listitem>
  619. <listitem><para>
  620. <code>getDefaultDisplayGroupClass($class)</code>
  621. </para></listitem>
  622. </itemizedlist>
  623. </sect3>
  624. <sect3 id="zend.form.forms.displaygroups.methods">
  625. <title>Métodos Zend_Form_DisplayGroup</title>
  626. <para>
  627. <code>Zend_Form_DisplayGroup</code> tiene los siguientes métodos,
  628. agrupados por tipo:
  629. </para>
  630. <itemizedlist>
  631. <listitem><para>Configuración:</para>
  632. <itemizedlist>
  633. <listitem><para><code>setOptions(array $options)</code></para></listitem>
  634. <listitem><para><code>setConfig(Zend_Config $config)</code></para></listitem>
  635. </itemizedlist>
  636. </listitem>
  637. <listitem><para>Metadatos:</para>
  638. <itemizedlist>
  639. <listitem><para><code>setAttrib($key, $value)</code></para></listitem>
  640. <listitem><para><code>addAttribs(array $attribs)</code></para></listitem>
  641. <listitem><para><code>setAttribs(array $attribs)</code></para></listitem>
  642. <listitem><para><code>getAttrib($key)</code></para></listitem>
  643. <listitem><para><code>getAttribs()</code></para></listitem>
  644. <listitem><para><code>removeAttrib($key)</code></para></listitem>
  645. <listitem><para><code>clearAttribs()</code></para></listitem>
  646. <listitem><para><code>setName($name)</code></para></listitem>
  647. <listitem><para><code>getName()</code></para></listitem>
  648. <listitem><para><code>setDescription($value)</code></para></listitem>
  649. <listitem><para><code>getDescription()</code></para></listitem>
  650. <listitem><para><code>setLegend($legend)</code></para></listitem>
  651. <listitem><para><code>getLegend()</code></para></listitem>
  652. <listitem><para><code>setOrder($order)</code></para></listitem>
  653. <listitem><para><code>getOrder()</code></para></listitem>
  654. </itemizedlist>
  655. </listitem>
  656. <listitem><para>Elementos:</para>
  657. <itemizedlist>
  658. <listitem><para><code>createElement($type, $name, array $options = array())</code></para></listitem>
  659. <listitem><para><code>addElement($typeOrElement, $name, array $options = array())</code></para></listitem>
  660. <listitem><para><code>addElements(array $elements)</code></para></listitem>
  661. <listitem><para><code>setElements(array $elements)</code></para></listitem>
  662. <listitem><para><code>getElement($name)</code></para></listitem>
  663. <listitem><para><code>getElements()</code></para></listitem>
  664. <listitem><para><code>removeElement($name)</code></para></listitem>
  665. <listitem><para><code>clearElements()</code></para></listitem>
  666. </itemizedlist>
  667. </listitem>
  668. <listitem><para>Cargadores Complemento:</para>
  669. <itemizedlist>
  670. <listitem><para><code>setPluginLoader(Zend_Loader_PluginLoader $loader)</code></para></listitem>
  671. <listitem><para><code>getPluginLoader()</code></para></listitem>
  672. <listitem><para><code>addPrefixPath($prefix, $path)</code></para></listitem>
  673. <listitem><para><code>addPrefixPaths(array $spec)</code></para></listitem>
  674. </itemizedlist>
  675. </listitem>
  676. <listitem><para>Decoratores:</para>
  677. <itemizedlist>
  678. <listitem><para><code>addDecorator($decorator, $options = null)</code></para></listitem>
  679. <listitem><para><code>addDecorators(array $decorators)</code></para></listitem>
  680. <listitem><para><code>setDecorators(array $decorators)</code></para></listitem>
  681. <listitem><para><code>getDecorator($name)</code></para></listitem>
  682. <listitem><para><code>getDecorators()</code></para></listitem>
  683. <listitem><para><code>removeDecorator($name)</code></para></listitem>
  684. <listitem><para><code>clearDecorators()</code></para></listitem>
  685. </itemizedlist>
  686. </listitem>
  687. <listitem><para>Generadores:</para>
  688. <itemizedlist>
  689. <listitem><para><code>setView(Zend_View_Interface $view = null)</code></para></listitem>
  690. <listitem><para><code>getView()</code></para></listitem>
  691. <listitem><para><code>render(Zend_View_Interface $view = null)</code></para></listitem>
  692. </itemizedlist>
  693. </listitem>
  694. <listitem><para>I18n:</para>
  695. <itemizedlist>
  696. <listitem><para><code>setTranslator(Zend_Translate_Adapter $translator = null)</code></para></listitem>
  697. <listitem><para><code>getTranslator()</code></para></listitem>
  698. <listitem><para><code>setDisableTranslator($flag)</code></para></listitem>
  699. <listitem><para><code>translatorIsDisabled()</code></para></listitem>
  700. </itemizedlist>
  701. </listitem>
  702. </itemizedlist>
  703. </sect3>
  704. </sect2>
  705. <sect2 id="zend.form.forms.subforms">
  706. <title>Subformularios</title>
  707. <para>
  708. Los Sub formularios sirven para diferentes propósitos:
  709. </para>
  710. <itemizedlist>
  711. <listitem><para>
  712. Crear grupos de elementos lógicos. Dado que los sub formularios son
  713. simplemente formularios, se pueden validar subformularios como entidades individuales.
  714. </para></listitem>
  715. <listitem><para>
  716. Crear formularios multi-páginas. Dado que los sub formularios son simplemente formularios,
  717. se puede deplegar un sub formulario por separado por página, incrementando formularios
  718. multi-páginas donde cada formulario tiene su propia validación lógica. Solo una vez
  719. que todos los sub formularios se validen, el formulario se consideraría completo.
  720. </para></listitem>
  721. <listitem><para>
  722. Agrupaciones de visualización. Como grupos de visualización, los sub formularios, cuando son generados
  723. como parte de un formulario más grande, pueden ser usados para agrupar elementos. Sea consciente,
  724. de todas maneras, que el objeto formulario principal no tendrá
  725. conocimiento de los elementos en un sub formulario.
  726. </para></listitem>
  727. </itemizedlist>
  728. <para>
  729. Un sub formulario puede ser un objeto <classname>Zend_Form</classname> o mas
  730. originalmente, un objeto <code>Zend_Form_SubForm</code>. éste último
  731. contiene decoradores apropiados para la inclusión en un formulario extenso (i.e.,
  732. no se generan adicionales formulario etiquetas HTML, pero si grupos de
  733. elementos). Para adjuntar un sub formulario, simplemente añádalo al formulario y déle
  734. un nombre:
  735. </para>
  736. <programlisting role="php"><![CDATA[
  737. $form->addSubForm($subForm, 'subform');
  738. ]]></programlisting>
  739. <para>
  740. Se puede recuperar un sub formulario usando ya sea
  741. <code>getSubForm($name)</code> o sobrecarga usando el nombre
  742. del sub formulario:
  743. </para>
  744. <programlisting role="php"><![CDATA[
  745. // Usando getSubForm():
  746. $subForm = $form->getSubForm('subform');
  747. // Usando sobrecarga:
  748. $subForm = $form->subform;
  749. ]]></programlisting>
  750. <para>
  751. Los Subformularios son incluidos en la interacción del formulario, sin embargo los elementos
  752. que lo contienen no lo son
  753. </para>
  754. <sect3 id="zend.form.forms.subforms.global">
  755. <title>Operaciones Globales</title>
  756. <para>
  757. Como los elementos y los grupos de visualización, existen algunas operaciones que
  758. pueden afectar a todos los sub formularios. A diferencia de los grupos de visualización y los
  759. elementos, sin embargo, los sub formularios heredan más funcionalidad del
  760. objeto formulario principal, y la única operación real que puede
  761. realizarse globalmente es determinar decoradores para sub formularios. Para
  762. este propósito, existe el método <code>setSubFormDecorators()</code>.
  763. En el siguiente ejemplo, determinaremos el decorador para todos los
  764. subformularios que sera un simple campo (el decorador FormElements es
  765. necesario para asegurar que los elementos son iterados):
  766. </para>
  767. <programlisting role="php"><![CDATA[
  768. $form->setSubFormDecorators(array(
  769. 'FormElements',
  770. 'Fieldset'
  771. ));
  772. ]]></programlisting>
  773. </sect3>
  774. <sect3 id="zend.form.forms.subforms.methods">
  775. <title>Métodos para interactuar con Sub Formularios</title>
  776. <para>
  777. Los siguientes métodos pueden ser usados para interactuar con sub formularios:
  778. </para>
  779. <itemizedlist>
  780. <listitem><para>
  781. <code>addSubForm(Zend_Form $form, $name, $order = null)</code>
  782. </para></listitem>
  783. <listitem><para>
  784. <code>addSubForms(array $subForms)</code>
  785. </para></listitem>
  786. <listitem><para>
  787. <code>setSubForms(array $subForms)</code>
  788. </para></listitem>
  789. <listitem><para>
  790. <code>getSubForm($name)</code>
  791. </para></listitem>
  792. <listitem><para>
  793. <code>getSubForms()</code>
  794. </para></listitem>
  795. <listitem><para>
  796. <code>removeSubForm($name)</code>
  797. </para></listitem>
  798. <listitem><para>
  799. <code>clearSubForms()</code>
  800. </para></listitem>
  801. <listitem><para>
  802. <code>setSubFormDecorators(array $decorators)</code>
  803. </para></listitem>
  804. </itemizedlist>
  805. </sect3>
  806. </sect2>
  807. <sect2 id="zend.form.forms.metadata">
  808. <title>Metadatos y Atributos</title>
  809. <para>
  810. Mientras la utilidad de un formulario primariamente deriva de los elementos
  811. que contiene, también pueden contener otros metadatos, como un nombre (usado
  812. a menudo como ID único en el marcado HTML ); la accion y el método del formulario;
  813. el número de elementos, grupos y sub formularios que lo contienen; y
  814. arbitrariamente metadatos (usualmente usados para determinar atributos HTML para la
  815. etiqueta del propio formulario).
  816. </para>
  817. <para>
  818. Se puede determinar y recuperar el nombre del formulario usando el accesor nombre:
  819. </para>
  820. <programlisting role="php"><![CDATA[
  821. // Determinar el nombre:
  822. $form->setName('registration');
  823. // Recuperar el nombre:
  824. $name = $form->getName();
  825. ]]></programlisting>
  826. <para>
  827. Para determinar la acción (url en el cual se envia el formulario) y método (método
  828. por el cual debería enviar, ej. 'POST' or 'GET'), use los accesores acción
  829. y método:
  830. </para>
  831. <programlisting role="php"><![CDATA[
  832. // Determinar la acción y método:
  833. $form->setAction('/user/login')
  834. ->setMethod('post');
  835. ]]></programlisting>
  836. <para>
  837. Se puede también especificar el tipo de codificación del fomulario usando el
  838. enctype accessors. Zend_Form define dos constantes,
  839. <code>Zend_Form::ENCTYPE_URLENCODED</code> y
  840. <code>Zend_Form::ENCTYPE_MULTIPART</code>, correspondiente a los
  841. valores 'application/x-www-form-urlencoded' y
  842. 'multipart/form-data', respectivamente; sin embargo, puede configurarlo
  843. con cualquier tipo de codificación.
  844. </para>
  845. <programlisting role="php"><![CDATA[
  846. // Determinar la acción, método y enctype:
  847. $form->setAction('/user/login')
  848. ->setMethod('post')
  849. ->setEnctype(Zend_Form::ENCTYPE_MULTIPART);
  850. ]]></programlisting>
  851. <note>
  852. <para>
  853. El método, acción y enctype son solo usados internamente para generar,
  854. y no para algún tipo de validación.
  855. </para>
  856. </note>
  857. <para>
  858. <classname>Zend_Form</classname> implementa la interfaz <code>Countable</code>
  859. permitiéndole pasarlo como un argumento para contar:
  860. </para>
  861. <programlisting role="php"><![CDATA[
  862. $numItems = count($form);
  863. ]]></programlisting>
  864. <para>
  865. Determinar metadatos arbitrariamente se realiza a través de los accesores 'atribs'.
  866. Dado que la sobrecarga en <classname>Zend_Form</classname> es usada para acceder
  867. elementos, grupos de visualización y subformularios, este es el único método para
  868. acceder a los metadatos.
  869. </para>
  870. <programlisting role="php"><![CDATA[
  871. // Determinando atributos:
  872. $form->setAttrib('class', 'zend-form')
  873. ->addAttribs(array(
  874. 'id' => 'registration',
  875. 'onSubmit' => 'validate(this)',
  876. ));
  877. // Recuperando atributos:
  878. $class = $form->getAttrib('class');
  879. $attribs = $form->getAttribs();
  880. // Removiendo atributos:
  881. $form->removeAttrib('onSubmit');
  882. // Limpiando todos los atributos:
  883. $form->clearAttribs();
  884. ]]></programlisting>
  885. </sect2>
  886. <sect2 id="zend.form.forms.decorators">
  887. <title>Decoradores</title>
  888. <para>
  889. Crear el marcado para un formulario es a menudo una tarea que consume mucho tiempo,
  890. particularmente si se planea reusar el mismo marcado para mostrar acciones
  891. tales como validación de errores, enviar valores, etc.
  892. La respuesta de <classname>Zend_Form</classname> a este problema es los
  893. <emphasis>decoradores</emphasis>.
  894. </para>
  895. <para>
  896. Los decoradores para objetos <classname>Zend_Form</classname> pueden ser usados para generar
  897. un formulario. El decorador FormElements iterará a través de todos los elementos en
  898. un formulario -- elementos, grupos de visualización y subformularios -- y los generará,
  899. devolviendo el resultado. Adicionalmente, los decoradores pueden ser usados
  900. para envolver el contenido o anteponerlo o postponerlo.
  901. </para>
  902. <para>
  903. Los decoradores por defecto de <classname>Zend_Form</classname> son FormElements,
  904. HtmlTag (envuelve una lista de definición) y Form; el código equivalente
  905. para crearlos es como sigue:
  906. </para>
  907. <programlisting role="php"><![CDATA[
  908. $form->setDecorators(array(
  909. 'FormElements',
  910. array('HtmlTag', array('tag' => 'dl')),
  911. 'Form'
  912. ));
  913. ]]></programlisting>
  914. <para>
  915. Que crea la salida como sigue:
  916. </para>
  917. <programlisting role="html"><![CDATA[
  918. <form action="/form/action" method="post">
  919. <dl>
  920. ...
  921. </dl>
  922. </form>
  923. ]]></programlisting>
  924. <para>
  925. Algunos de los atributos se determinan en el objeto formulario que será usado como
  926. atributos HTML de la etiqueta <code>&lt;form&gt;</code>.
  927. </para>
  928. <note>
  929. <title>Decoradores por defecto que no necesitan ser cargados</title>
  930. <para>
  931. Por defecto, el decorador por defecto son cargados durante la
  932. inicialización del objeto. Puede deshabilitarlo pasando la
  933. opción 'disableLoadDefaultDecorators' al constructor:
  934. </para>
  935. <programlisting role="php"><![CDATA[
  936. $form = new Zend_Form(array('disableLoadDefaultDecorators' => true));
  937. ]]></programlisting>
  938. <para>
  939. Esta opción puede ser combinada con alguna otra opción que usted pueda pasar,
  940. tanto como opciones de array o en un objeto <code>Zend_Config</code>
  941. </para>
  942. </note>
  943. <note>
  944. <title>Usando multiples decoradores del mismo tipo</title>
  945. <para>
  946. Internamente, <classname>Zend_Form</classname> usa una clase decorador
  947. como un mecanismo buscador cuando se recuperan decoradores. Como
  948. resultado, no se pueden registrar multiples decoradores del mismo
  949. tipo; subsecuentemente los decoradores simplemente sobrescribirán esos
  950. decoradores que existían antes.
  951. </para>
  952. <para>
  953. Para conseguir esto, se pueden usar alias. En vez de pasar un
  954. decorador o un nombre de decorador como primer argumento a
  955. <code>addDecorator()</code>, pase un array con un solo
  956. elemento, con el alias apuntando al objeto decorador o
  957. nombre:
  958. </para>
  959. <programlisting role="php"><![CDATA[
  960. // Alias para 'FooBar':
  961. $form->addDecorator(array('FooBar' => 'HtmlTag'), array('tag' => 'div'));
  962. // y recuperarlo después:
  963. $form = $element->getDecorator('FooBar');
  964. ]]></programlisting>
  965. <para>
  966. En los métodos <code>addDecorators()</code> y
  967. <code>setDecorators()</code>, se necesitará pasar
  968. la opción 'decorator' en el array representando el decorador:
  969. </para>
  970. <programlisting role="php"><![CDATA[
  971. // Añadir dos decoradores 'HtmlTag', poniendo un alias a 'FooBar':
  972. $form->addDecorators(
  973. array('HtmlTag', array('tag' => 'div')),
  974. array(
  975. 'decorator' => array('FooBar' => 'HtmlTag'),
  976. 'options' => array('tag' => 'dd')
  977. ),
  978. );
  979. // y recuperándolo después:
  980. $htmlTag = $form->getDecorator('HtmlTag');
  981. $fooBar = $form->getDecorator('FooBar');
  982. ]]></programlisting>
  983. </note>
  984. <para>
  985. Puede crear su propio decorador para generar el formulario. Un
  986. caso de uso común es si sabe el HTML exacto que desea usar; su
  987. decorador puede crear el mismo HTML y simplemente retornarlo,
  988. potencialmente usando los decoradores de individuales elementos o
  989. grupos de visualización.
  990. </para>
  991. <para>
  992. Los siguientes métodos puden ser usados para interactuar con decoradores:
  993. </para>
  994. <itemizedlist>
  995. <listitem><para>
  996. <code>addDecorator($decorator, $options = null)</code>
  997. </para></listitem>
  998. <listitem><para>
  999. <code>addDecorators(array $decorators)</code>
  1000. </para></listitem>
  1001. <listitem><para>
  1002. <code>setDecorators(array $decorators)</code>
  1003. </para></listitem>
  1004. <listitem><para>
  1005. <code>getDecorator($name)</code>
  1006. </para></listitem>
  1007. <listitem><para>
  1008. <code>getDecorators()</code>
  1009. </para></listitem>
  1010. <listitem><para>
  1011. <code>removeDecorator($name)</code>
  1012. </para></listitem>
  1013. <listitem><para>
  1014. <code>clearDecorators()</code>
  1015. </para></listitem>
  1016. </itemizedlist>
  1017. <para>
  1018. <classname>Zend_Form</classname> también usa sobrecarga que permite generar
  1019. decoradores específicos. <code>__call()</code> interceptará métodos
  1020. que lleve con el texto 'render' y use el resto del nombre del método
  1021. para buscar un decorador; si se encuentran, serán generados por un
  1022. <emphasis>solo</emphasis> decorador. Cualquier argumento pasado a la
  1023. llamada del método será usado como contenido que pasar al método
  1024. <code>render()</code> del decorador. Como ejemplo:
  1025. </para>
  1026. <programlisting role="php"><![CDATA[
  1027. // Generar solo los decoradores FormElements:
  1028. echo $form->renderFormElements();
  1029. // Generar solo el campo decorador, pasando el contenido:
  1030. echo $form->renderFieldset("<p>This is fieldset content</p>");
  1031. ]]></programlisting>
  1032. <para>
  1033. Si el decorador no existe, una excepción se creará.
  1034. </para>
  1035. </sect2>
  1036. <sect2 id="zend.form.forms.validation">
  1037. <title>Validación</title>
  1038. <para>
  1039. Un caso de uso primario para formularios es validar datos enviados.
  1040. <classname>Zend_Form</classname> le permite validar un formulario entero de una vez,
  1041. o una parte de él, asi como también automatizar las respuestas de validación para
  1042. XmlHttpRequests (AJAX). Si los datos enviados no son válidos, contiene
  1043. métodos para recuperar los distintos códigos errores y los mensajes de
  1044. elementos y subformularios de validaciones fallidas.
  1045. </para>
  1046. <para>
  1047. Para validar un formulario entero, use el método <code>isValid()</code>:
  1048. </para>
  1049. <programlisting role="php"><![CDATA[
  1050. if (!$form->isValid($_POST)) {
  1051. // validación fallida
  1052. }
  1053. ]]></programlisting>
  1054. <para>
  1055. <code>isValid()</code> validará cada elemento requerido, y algún
  1056. elemento no requerido contenido en la data sometida.
  1057. </para>
  1058. <para>
  1059. Algunas veces se necesitará validar sólo un subset del dato; para
  1060. esto use <code>isValidPartial($data)</code>:
  1061. </para>
  1062. <programlisting role="php"><![CDATA[
  1063. if (!$form->isValidPartial($data)) {
  1064. // validación fallida
  1065. }
  1066. ]]></programlisting>
  1067. <para>
  1068. <code>isValidPartial()</code> sólo intenta validar aquellos elementos
  1069. en la información para los cuales existen similares elementos; si un elemento es
  1070. no representado en la información, es pasado por alto.
  1071. </para>
  1072. <para>
  1073. Cuando se validan elementos o grupos de elementos para un requeirimiento AJAX,
  1074. típicamente se validará un subset del formulario, y quiere la respuesta
  1075. en JSON. <code>processAjax()</code> precisamente realiza eso:
  1076. </para>
  1077. <programlisting role="php"><![CDATA[
  1078. $json = $form->processAjax($data);
  1079. ]]></programlisting>
  1080. <para>
  1081. Entonces, puede simplemente enviar la respuesta JSON al cliente. Si el
  1082. formulario es válido, ésta será una respuesta booleana. Si no, será
  1083. un objeto javascript conteniendo pares de clave/mensaje, donde cada
  1084. 'message' es un array de validación de mensajes de error.
  1085. </para>
  1086. <para>
  1087. Para los formularios que fallan la validación, se pueden recuperar ambos códigos
  1088. de error y mensajes de error, usando <code>getErrors()</code> y
  1089. <code>getMessages()</code>, respectivamente:
  1090. </para>
  1091. <programlisting role="php"><![CDATA[
  1092. $codes = $form->getErrors();
  1093. $messages = $form->getMessage();
  1094. ]]></programlisting>
  1095. <note>
  1096. <para>
  1097. Dado que los mensajes devueltos por <code>getMessages()</code> son un
  1098. array de pares de errores código/mensaje, <code>getErrors()</code> no
  1099. es necesario.
  1100. </para>
  1101. </note>
  1102. <para>
  1103. Puede recuperar códigos y mensajes de error para elementos individuales
  1104. simplemente pasando el nombre del elemento a cada uno:
  1105. </para>
  1106. <programlisting role="php"><![CDATA[
  1107. $codes = $form->getErrors('username');
  1108. $messages = $form->getMessages('username');
  1109. ]]></programlisting>
  1110. <note>
  1111. <para>
  1112. Nota: Cuando validamos elementos, <classname>Zend_Form</classname> envía un
  1113. segundo argumento a cada método <code>isValid()</code> del elemento:
  1114. el array de los datos que se están validando. Esto puede ser usado por
  1115. validadores individuales para permitirles utilizar otros valores
  1116. enviados al determinar la validez de los datos. Un ejemplo
  1117. sería un formulario de registro que requiere tanto una contraseña
  1118. como una confirmación de la contraseña; el elemento contraseña puede usar la
  1119. confirmación de la contraseña como parte de su validación.
  1120. </para>
  1121. </note>
  1122. <sect3 id="zend.form.forms.validation.errors">
  1123. <title>Mensajes de error personalizados</title>
  1124. <para>
  1125. A veces, puede querer especificar uno o más mensajes
  1126. de error en vez de los mensajes de error generados por los
  1127. validadores adjuntos a los elementos. Adicionalmente, a veces
  1128. puede querer marcar el formulario inválido usted mismo. Como 1.6.0,
  1129. esta funcionalidad es posible siguiendo los métodos.
  1130. At times, you may want to specify one or more specific error
  1131. messages to use instead of the error messages generated by the
  1132. validators attached to your elements. Additionally, at times you
  1133. may want to mark the form invalid yourself. As of 1.6.0, this
  1134. functionality is possible via the following methods.
  1135. </para>
  1136. <itemizedlist>
  1137. <listitem><para>
  1138. <code>addErrorMessage($message)</code>: añade un mensaje de error
  1139. para desplegar en el formulario los errores de validación. Se debe llamar más
  1140. de una vez, y los nuevos mensajes son adicionados a la pila.
  1141. </para></listitem>
  1142. <listitem><para>
  1143. <code>addErrorMessages(array $messages)</code>: añade múltiples
  1144. mensajes de error para desplegar en el formulario los errores de validación
  1145. </para></listitem>
  1146. <listitem><para>
  1147. <code>setErrorMessages(array $messages)</code>: añade multiples
  1148. mensajes de error para desplegar en el formulario los errores de validación,
  1149. sobrescribiendo todos los mensajes de error previamente determinados.
  1150. </para></listitem>
  1151. <listitem><para>
  1152. <code>getErrorMessages()</code>: recupera la lista de
  1153. mensajes de error personalizados que han sido definidos.
  1154. </para></listitem>
  1155. <listitem><para>
  1156. <code>clearErrorMessages()</code>: remueve todos los mensajes
  1157. de error personalizados que han sido definidos.
  1158. </para></listitem>
  1159. <listitem><para>
  1160. <code>markAsError()</code>: marca el formulario como que la
  1161. validación ha fallado.
  1162. </para></listitem>
  1163. <listitem><para>
  1164. <code>addError($message)</code>: añade un mensaje a la pila de
  1165. mensajes de error personalizados y señala al formulario como inválido.
  1166. </para></listitem>
  1167. <listitem><para>
  1168. <code>addErrors(array $messages)</code>: añade muchos
  1169. mensajes a la pila de mensajes de error personalizados y señala al
  1170. formulario como inválido.
  1171. </para></listitem>
  1172. <listitem><para>
  1173. <code>setErrors(array $messages)</code>: sobrescribe la
  1174. pila de mensajes de error personalizada con los mensajes proporcionados
  1175. y señala el formulario como inválido.
  1176. </para></listitem>
  1177. </itemizedlist>
  1178. <para>
  1179. Todos los errores determinados de esta manera pueden ser traducidos.
  1180. </para>
  1181. </sect3>
  1182. </sect2>
  1183. <sect2 id="zend.form.forms.methods">
  1184. <title>Métodos</title>
  1185. <para>
  1186. La siguiente lista es la lista completa de métodos disponibles para
  1187. <classname>Zend_Form</classname>, agrupados por tipo:
  1188. </para>
  1189. <itemizedlist>
  1190. <listitem><para>Configuración y opciones:</para>
  1191. <itemizedlist>
  1192. <listitem><para><code>setOptions(array $options)</code></para></listitem>
  1193. <listitem><para><code>setConfig(Zend_Config $config)</code></para></listitem>
  1194. </itemizedlist>
  1195. </listitem>
  1196. <listitem><para>Cargadores de plugins y rutas:</para>
  1197. <itemizedlist>
  1198. <listitem><para><code>setPluginLoader(Zend_Loader_PluginLoader_Interface $loader, $type = null)</code></para></listitem>
  1199. <listitem><para><code>getPluginLoader($type = null)</code></para></listitem>
  1200. <listitem><para><code>addPrefixPath($prefix, $path, $type = null) </code></para></listitem>
  1201. <listitem><para><code>addPrefixPaths(array $spec)</code></para></listitem>
  1202. <listitem><para><code>addElementPrefixPath($prefix, $path, $type = null)</code></para></listitem>
  1203. <listitem><para><code>addElementPrefixPaths(array $spec)</code></para></listitem>
  1204. <listitem><para><code>addDisplayGroupPrefixPath($prefix, $path)</code></para></listitem>
  1205. </itemizedlist>
  1206. </listitem>
  1207. <listitem><para>Metadato:</para>
  1208. <itemizedlist>
  1209. <listitem><para><code>setAttrib($key, $value)</code></para></listitem>
  1210. <listitem><para><code>addAttribs(array $attribs)</code></para></listitem>
  1211. <listitem><para><code>setAttribs(array $attribs)</code></para></listitem>
  1212. <listitem><para><code>getAttrib($key)</code></para></listitem>
  1213. <listitem><para><code>getAttribs()</code></para></listitem>
  1214. <listitem><para><code>removeAttrib($key)</code></para></listitem>
  1215. <listitem><para><code>clearAttribs()</code></para></listitem>
  1216. <listitem><para><code>setAction($action)</code></para></listitem>
  1217. <listitem><para><code>getAction()</code></para></listitem>
  1218. <listitem><para><code>setMethod($method)</code></para></listitem>
  1219. <listitem><para><code>getMethod()</code></para></listitem>
  1220. <listitem><para><code>setName($name)</code></para></listitem>
  1221. <listitem><para><code>getName()</code></para></listitem>
  1222. </itemizedlist>
  1223. </listitem>
  1224. <listitem><para>Elementos:</para>
  1225. <itemizedlist>
  1226. <listitem><para><code>addElement($element, $name = null, $options = null)</code></para></listitem>
  1227. <listitem><para><code>addElements(array $elements)</code></para></listitem>
  1228. <listitem><para><code>setElements(array $elements)</code></para></listitem>
  1229. <listitem><para><code>getElement($name)</code></para></listitem>
  1230. <listitem><para><code>getElements()</code></para></listitem>
  1231. <listitem><para><code>removeElement($name)</code></para></listitem>
  1232. <listitem><para><code>clearElements()</code></para></listitem>
  1233. <listitem><para><code>setDefaults(array $defaults)</code></para></listitem>
  1234. <listitem><para><code>setDefault($name, $value)</code></para></listitem>
  1235. <listitem><para><code>getValue($name)</code></para></listitem>
  1236. <listitem><para><code>getValues()</code></para></listitem>
  1237. <listitem><para><code>getUnfilteredValue($name)</code></para></listitem>
  1238. <listitem><para><code>getUnfilteredValues()</code></para></listitem>
  1239. <listitem><para><code>setElementFilters(array $filters)</code></para></listitem>
  1240. <listitem><para><code>setElementDecorators(array $decorators)</code></para></listitem>
  1241. </itemizedlist>
  1242. </listitem>
  1243. <listitem><para>Subformularios:</para>
  1244. <itemizedlist>
  1245. <listitem><para><code>addSubForm(Zend_Form $form, $name, $order = null)</code></para></listitem>
  1246. <listitem><para><code>addSubForms(array $subForms)</code></para></listitem>
  1247. <listitem><para><code>setSubForms(array $subForms)</code></para></listitem>
  1248. <listitem><para><code>getSubForm($name)</code></para></listitem>
  1249. <listitem><para><code>getSubForms()</code></para></listitem>
  1250. <listitem><para><code>removeSubForm($name)</code></para></listitem>
  1251. <listitem><para><code>clearSubForms()</code></para></listitem>
  1252. <listitem><para><code>setSubFormDecorators(array $decorators)</code></para></listitem>
  1253. </itemizedlist>
  1254. </listitem>
  1255. <listitem><para>Grupos de Visualización</para>
  1256. <itemizedlist>
  1257. <listitem><para><code>addDisplayGroup(array $elements, $name, $options = null)</code></para></listitem>
  1258. <listitem><para><code>addDisplayGroups(array $groups)</code></para></listitem>
  1259. <listitem><para><code>setDisplayGroups(array $groups)</code></para></listitem>
  1260. <listitem><para><code>getDisplayGroup($name)</code></para></listitem>
  1261. <listitem><para><code>getDisplayGroups()</code></para></listitem>
  1262. <listitem><para><code>removeDisplayGroup($name)</code></para></listitem>
  1263. <listitem><para><code>clearDisplayGroups()</code></para></listitem>
  1264. <listitem><para><code>setDisplayGroupDecorators(array $decorators)</code></para></listitem>
  1265. </itemizedlist>
  1266. </listitem>
  1267. <listitem><para>Validación</para>
  1268. <itemizedlist>
  1269. <listitem><para><code>populate(array $values)</code></para></listitem>
  1270. <listitem><para><code>isValid(array $data)</code></para></listitem>
  1271. <listitem><para><code>isValidPartial(array $data)</code></para></listitem>
  1272. <listitem><para><code>processAjax(array $data)</code></para></listitem>
  1273. <listitem><para><code>persistData()</code></para></listitem>
  1274. <listitem><para><code>getErrors($name = null)</code></para></listitem>
  1275. <listitem><para><code>getMessages($name = null)</code></para></listitem>
  1276. </itemizedlist>
  1277. </listitem>
  1278. <listitem><para>Generadores:</para>
  1279. <itemizedlist>
  1280. <listitem><para><code>setView(Zend_View_Interface $view = null)</code></para></listitem>
  1281. <listitem><para><code>getView()</code></para></listitem>
  1282. <listitem><para><code>addDecorator($decorator, $options = null)</code></para></listitem>
  1283. <listitem><para><code>addDecorators(array $decorators)</code></para></listitem>
  1284. <listitem><para><code>setDecorators(array $decorators)</code></para></listitem>
  1285. <listitem><para><code>getDecorator($name)</code></para></listitem>
  1286. <listitem><para><code>getDecorators()</code></para></listitem>
  1287. <listitem><para><code>removeDecorator($name)</code></para></listitem>
  1288. <listitem><para><code>clearDecorators()</code></para></listitem>
  1289. <listitem><para><code>render(Zend_View_Interface $view = null)</code></para></listitem>
  1290. </itemizedlist>
  1291. </listitem>
  1292. <listitem><para>I18n:</para>
  1293. <itemizedlist>
  1294. <listitem><para><code>setTranslator(Zend_Translate_Adapter $translator = null)</code></para></listitem>
  1295. <listitem><para><code>getTranslator()</code></para></listitem>
  1296. <listitem><para><code>setDisableTranslator($flag)</code></para></listitem>
  1297. <listitem><para><code>translatorIsDisabled()</code></para></listitem>
  1298. </itemizedlist>
  1299. </listitem>
  1300. </itemizedlist>
  1301. </sect2>
  1302. <sect2 id="zend.form.forms.config">
  1303. <title>Configuración</title>
  1304. <para>
  1305. <classname>Zend_Form</classname> es totalmente configurable mediante
  1306. <code>setOptions()</code> y <code>setConfig()</code> (o
  1307. pasando opciones o un objeto <code>Zend_Config</code> al
  1308. constructor). Usando estos métodos, se pueden especificar elementos formulario,
  1309. grupos de visualización, decoradores, y metadatos.
  1310. </para>
  1311. <para>
  1312. Como regla general, si 'set' + la clave de opción (option key) hacen referencia a
  1313. métodos <classname>Zend_Form</classname>, entonces el valor proporcionado será
  1314. pasado al método. Si el accessor no existe, se asume que la clave
  1315. referencia a un atributo, y será pasado a
  1316. <code>setAttrib()</code>.
  1317. </para>
  1318. <para>
  1319. Excepciones a las reglas incluyen lo siguiente:
  1320. </para>
  1321. <itemizedlist>
  1322. <listitem><para>
  1323. <code>prefixPaths</code> será pasado a
  1324. <code>addPrefixPaths()</code>
  1325. </para></listitem>
  1326. <listitem><para>
  1327. <code>elementPrefixPaths</code> será pasado a
  1328. <code>addElementPrefixPaths()</code>
  1329. </para></listitem>
  1330. <listitem><para>
  1331. <code>displayGroupPrefixPaths</code> será pasado a
  1332. <code>addDisplayGroupPrefixPaths()</code>
  1333. </para></listitem>
  1334. <listitem>
  1335. <para>los siguientes establecedores no pueden ser determinado de ésta manera:</para>
  1336. <itemizedlist>
  1337. <listitem><para><code>setAttrib (aunque setAttribs *funcionará*)</code></para></listitem>
  1338. <listitem><para><code>setConfig</code></para></listitem>
  1339. <listitem><para><code>setDefault</code></para></listitem>
  1340. <listitem><para><code>setOptions</code></para></listitem>
  1341. <listitem><para><code>setPluginLoader</code></para></listitem>
  1342. <listitem><para><code>setSubForms</code></para></listitem>
  1343. <listitem><para><code>setTranslator</code></para></listitem>
  1344. <listitem><para><code>setView</code></para></listitem>
  1345. </itemizedlist>
  1346. </listitem>
  1347. </itemizedlist>
  1348. <para>
  1349. Como un ejemplo, aquí esta un archivo de configuración que pasa la configuración
  1350. por cada tipo de datos configurables:
  1351. </para>
  1352. <programlisting role="ini"><![CDATA[
  1353. [element]
  1354. name = "registration"
  1355. action = "/user/register"
  1356. method = "post"
  1357. attribs.class = "zend_form"
  1358. attribs.onclick = "validate(this)"
  1359. disableTranslator = 0
  1360. prefixPath.element.prefix = "My_Element"
  1361. prefixPath.element.path = "My/Element/"
  1362. elementPrefixPath.validate.prefix = "My_Validate"
  1363. elementPrefixPath.validate.path = "My/Validate/"
  1364. displayGroupPrefixPath.prefix = "My_Group"
  1365. displayGroupPrefixPath.path = "My/Group/"
  1366. elements.username.type = "text"
  1367. elements.username.options.label = "Username"
  1368. elements.username.options.validators.alpha.validator = "Alpha"
  1369. elements.username.options.filters.lcase = "StringToLower"
  1370. ; more elements, of course...
  1371. elementFilters.trim = "StringTrim"
  1372. ;elementDecorators.trim = "StringTrim"
  1373. displayGroups.login.elements.username = "username"
  1374. displayGroups.login.elements.password = "password"
  1375. displayGroupDecorators.elements.decorator = "FormElements"
  1376. displayGroupDecorators.fieldset.decorator = "Fieldset"
  1377. decorators.elements.decorator = "FormElements"
  1378. decorators.fieldset.decorator = "FieldSet"
  1379. decorators.fieldset.decorator.options.class = "zend_form"
  1380. decorators.form.decorator = "Form"
  1381. ]]></programlisting>
  1382. <para>
  1383. El código de arriba fácilmente puede ser abstraído a un XML o un archivo de configuración basado en arrays PHP.
  1384. </para>
  1385. </sect2>
  1386. <sect2 id="zend.form.forms.custom">
  1387. <title>Formularios personalizados</title>
  1388. <para>
  1389. Una alternativa a usar los formularios basados en configuraciones es realizar una subclase de
  1390. <classname>Zend_Form</classname>. Esto tiene muchos beneficios:
  1391. </para>
  1392. <itemizedlist>
  1393. <listitem><para>
  1394. Se puede centrar la prueba de su formulario facilmente para asegurar las validaciones y
  1395. generar la ejecución esperada.
  1396. </para></listitem>
  1397. <listitem><para>
  1398. Control preciso sobre los individuales elementos.
  1399. </para></listitem>
  1400. <listitem><para>
  1401. Reutilización del objeto formulario, y mejor portabilidad (no se necesita
  1402. seguir los archivos de configuración).
  1403. </para></listitem>
  1404. <listitem><para>
  1405. Implementar funcionalidad personalizada.
  1406. </para></listitem>
  1407. </itemizedlist>
  1408. <para>
  1409. El caso mas típico de uso sería el método
  1410. <code>init()</code> para determinar elementos de formulario específicos y
  1411. de configuración:
  1412. </para>
  1413. <programlisting role="php"><![CDATA[
  1414. class My_Form_Login extends Zend_Form
  1415. {
  1416. public function init()
  1417. {
  1418. $username = new Zend_Form_Element_Text('username');
  1419. $username->class = 'formtext';
  1420. $username->setLabel('Username:')
  1421. ->setDecorators(array(
  1422. array('ViewHelper',
  1423. array('helper' => 'formText')),
  1424. array('Label',
  1425. array('class' => 'label'))
  1426. ));
  1427. $password = new Zend_Form_Element_Password('password');
  1428. $password->class = 'formtext';
  1429. $password->setLabel('Username:')
  1430. ->setDecorators(array(
  1431. array('ViewHelper',
  1432. array('helper' => 'formPassword')),
  1433. array('Label',
  1434. array('class' => 'label'))
  1435. ));
  1436. $submit = new Zend_Form_Element_Submit('login');
  1437. $submit->class = 'formsubmit';
  1438. $submit->setValue('Login')
  1439. ->setDecorators(array(
  1440. array('ViewHelper',
  1441. array('helper' => 'formSubmit'))
  1442. ));
  1443. $this->addElements(array(
  1444. $username,
  1445. $password,
  1446. $submit
  1447. ));
  1448. $this->setDecorators(array(
  1449. 'FormElements',
  1450. 'Fieldset',
  1451. 'Form'
  1452. ));
  1453. }
  1454. }
  1455. ]]></programlisting>
  1456. <para>
  1457. Este formulario puede ser instanciado simplemente así:
  1458. </para>
  1459. <programlisting role="php"><![CDATA[
  1460. $form = new My_Form_Login();
  1461. ]]></programlisting>
  1462. <para>
  1463. y toda la funcionalidad está instalada y lista; no se necesitan archivos
  1464. de configuración. (Note que este ejemplo esta simplificado, no contiene
  1465. validadores o filtros para los elementos.)
  1466. </para>
  1467. <para>
  1468. Otra razón común para la extension es definir un conjunto de
  1469. decoradores por defecto. Puede hacerlo sobreescribiendo el
  1470. método <code>loadDefaultDecorators()</code>:
  1471. </para>
  1472. <programlisting role="php"><![CDATA[
  1473. class My_Form_Login extends Zend_Form
  1474. {
  1475. public function loadDefaultDecorators()
  1476. {
  1477. $this->setDecorators(array(
  1478. 'FormElements',
  1479. 'Fieldset',
  1480. 'Form'
  1481. ));
  1482. }
  1483. }
  1484. ]]></programlisting>
  1485. </sect2>
  1486. </sect1>
  1487. <!--
  1488. vim:se ts=4 sw=4 et:
  1489. -->