Zend_Form-Elements.xml 59 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15103 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.form.elements">
  5. <title>Creando elementos de formulario usando Zend_Form_Element</title>
  6. <para>
  7. Un formulario esta compuesto de elementos, que normalmente corresponden
  8. al elemento HTML input. <classname>Zend_Form_Element</classname> encapsula
  9. elementos de formulario individualmente, con las siguientes áreas de
  10. responsabilidad:
  11. </para>
  12. <itemizedlist>
  13. <listitem>
  14. <para>
  15. validación (¿los datos enviados son válidos?)
  16. </para>
  17. <itemizedlist>
  18. <listitem><para>captura de códigos y mensajes de error</para></listitem>
  19. </itemizedlist>
  20. </listitem>
  21. <listitem><para>
  22. filtrado (¿cómo es escapado y normalizado el elemento para su
  23. validación y/o salida?
  24. </para></listitem>
  25. <listitem><para>
  26. generación (¿cómo es mostrado el elemento?)
  27. </para></listitem>
  28. <listitem><para>
  29. metadatos y atributos (¿qué información amplía la definición del
  30. elemento?)
  31. </para></listitem>
  32. </itemizedlist>
  33. <para>
  34. La clase base, <classname>Zend_Form_Element</classname>, funciona por defecto para
  35. varios casos, pero es mejor extender la clase para elementos con fines
  36. especiales de uso común. Adicionalmente, Zend Framework contiene un
  37. número de elementos XHTML estándar; puede leer de ellos <link linkend="zend.form.standardElements">en el capítulo Elementos
  38. Estándares</link>
  39. </para>
  40. <sect2 id="zend.form.elements.loaders">
  41. <title>Cargadores de Plugin</title>
  42. <para>
  43. <classname>Zend_Form_Element</classname> hace uso de <link linkend="zend.loader.pluginloader">Zend_Loader_PluginLoader</link>
  44. para permitir a los desarrolladores especificar ubicaciones de
  45. validadores, filtros y decoradores alternos. Cada uno tiene su
  46. propio cargador de plugin asociado a él y métodos de acceso
  47. generales usados para su recuperación y modificación.
  48. </para>
  49. <para>
  50. Los siguientes tipos de cargadores son usados con los varios métodos
  51. del cargador de plugin: 'validate', 'filter', y 'decorator'. Los
  52. nombres son sensibles a mayúsculas y minúsculas.
  53. </para>
  54. <para>
  55. Los métodos usados para interactuar con los cargadores de plugin son
  56. los siguientes:
  57. </para>
  58. <itemizedlist>
  59. <listitem><para>
  60. <code>setPluginLoader($loader, $type)</code>:
  61. <code>$loader</code> es el propio objeto cargador, mientras
  62. <code>$type</code> es uno de los tipos arriba mencionados. Esto
  63. establece el cargador de plugin para el tipo dado en el objeto
  64. cargador recién especificado.
  65. </para></listitem>
  66. <listitem><para>
  67. <code>getPluginLoader($type)</code>: obtiene el cargador de
  68. plugin asociado con <code>$type</code>.
  69. </para></listitem>
  70. <listitem><para>
  71. <code>addPrefixPath($prefix, $path, $type = null)</code>: agrega
  72. una asociación prefijo/ruta para el cargador especificado por
  73. <code>$type</code>. Si <code>$type</code> es null, se intentará
  74. agregar la ruta a todos los cargadores, añadiendo el prefijo a
  75. cada "_Validate", "_Filter" y "_Decorator"; y agregandole
  76. "Validate/", "Filter/" y "Decorator/" a la ruta. Si tiene todas
  77. sus clases extras para elementos de formulario dentro de
  78. una jerarquía común, este método es conveniente para establecer
  79. el prefijo para todas ellas.
  80. </para></listitem>
  81. <listitem><para>
  82. <code>addPrefixPaths(array $spec)</code>: le permite añadir
  83. varias rutas de una sola vez a uno o más cargadores de plugin.
  84. Se espera cada elemento de la matriz sea un array con claves
  85. 'path', 'prefix', y 'type'.
  86. </para></listitem>
  87. </itemizedlist>
  88. <para>
  89. Validadores, filtros y decoradores personalizados son una manera
  90. simple de compartir funcionalidad entre formularios y encapsular
  91. funcionalidad personalizada.
  92. </para>
  93. <example id="zend.form.elements.loaders.customLabel">
  94. <title>Etiqueta personalizada</title>
  95. <para>
  96. Un uso común de los plugins es proveer reemplazos para las
  97. clases estándares. Por ejemplo, si desea proveer una implementación diferente
  98. del decorador 'Label' -- por ejemplo, para
  99. añadir siempre dos puntos -- puede crear su propio decorador
  100. 'Label' con su propio prefijo de clase, y entonces añadirlo a su
  101. prefijo de ruta.
  102. </para>
  103. <para>
  104. Comencemos con un decorador de etiqueta personalizado. Le
  105. daremos el prefijo "My_Decorator", y la clase estará en el
  106. archivo "My/Decorator/Label.php".
  107. </para>
  108. <programlisting role="php"><![CDATA[
  109. class My_Decorator_Label extends Zend_Form_Decorator_Abstract
  110. {
  111. protected $_placement = 'PREPEND';
  112. public function render($content)
  113. {
  114. if (null === ($element = $this->getElement())) {
  115. return $content;
  116. }
  117. if (!method_exists($element, 'getLabel')) {
  118. return $content;
  119. }
  120. $label = $element->getLabel() . ':';
  121. if (null === ($view = $element->getView())) {
  122. return $this->renderLabel($content, $label);
  123. }
  124. $label = $view->formLabel($element->getName(), $label);
  125. return $this->renderLabel($content, $label);
  126. }
  127. public function renderLabel($content, $label)
  128. {
  129. $placement = $this->getPlacement();
  130. $separator = $this->getSeparator();
  131. switch ($placement) {
  132. case 'APPEND':
  133. return $content . $separator . $label;
  134. case 'PREPEND':
  135. default:
  136. return $label . $separator . $content;
  137. }
  138. }
  139. }
  140. ]]></programlisting>
  141. <para>
  142. Ahora diremos al elemento que use esta ruta cuando busque por
  143. decoradores:
  144. </para>
  145. <programlisting role="php"><![CDATA[
  146. $element->addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator');
  147. ]]></programlisting>
  148. <para>
  149. Alternativamente, podemos hacerlo en el formulario para asegurar
  150. que todos los decoradores usen esta ruta:
  151. </para>
  152. <programlisting role="php"><![CDATA[
  153. $form->addElementPrefixPath('My_Decorator', 'My/Decorator/', 'decorator');
  154. ]]></programlisting>
  155. <para>
  156. Con esta ruta añadida, cuando agregue un decorador, la ruta
  157. 'My/Decorator' será consultada primero en búsqueda de la
  158. existencia del decorador en este lugar. Como resultado,
  159. 'My_Decorator_Label' ahora será utilizado cuando el decorador
  160. 'Label' sea requerido.
  161. </para>
  162. </example>
  163. </sect2>
  164. <sect2 id="zend.form.elements.filters">
  165. <title>Filters</title>
  166. <para>
  167. A menudo es útil y/o necesario realizar alguna normalización en la
  168. entrada antes de la validación – por ejemplo, puede querer eliminar
  169. todo el HTML, pero realizar las validaciones sobre lo restante para
  170. asegurarse que el envío es válido. O puede eliminar los espacios en
  171. blanco al inicio o fin de la entrada para asegurarse de que un validador
  172. StringLenth (longitud de la cadena) no regrese un positivo falso. Estas
  173. operaciones pueden realizarse usando <code>Zend_Filter</code>, y
  174. <classname>Zend_Form_Element</classname> que soportan cadenas de filtros,
  175. permitiéndole especificar múltiples filtros secuenciales a utilizar.
  176. El filtrado sucede tanto en la validación como cuando recupera el
  177. valor del elemento vía <code>getValue()</code>:
  178. </para>
  179. <programlisting role="php"><![CDATA[
  180. $filtered = $element->getValue();
  181. ]]></programlisting>
  182. <para>
  183. Los filtros pueden ser agregados a la pila de dos maneras:
  184. </para>
  185. <itemizedlist>
  186. <listitem><para>
  187. pasándolo en una instancia de filtro específica
  188. </para></listitem>
  189. <listitem><para>
  190. proveyendo un nombre de filtro – el correspondiente nombre
  191. corto o completo de la clase
  192. </para></listitem>
  193. </itemizedlist>
  194. <para>
  195. Veamos algunos ejemplos:
  196. </para>
  197. <programlisting role="php"><![CDATA[
  198. // Instancia específica del filtro
  199. $element->addFilter(new Zend_Filter_Alnum());
  200. // El correspondiente nombre completo de la clase:
  201. $element->addFilter('Zend_Filter_Alnum');
  202. // Nombre corto del filtro:
  203. $element->addFilter('Alnum');
  204. $element->addFilter('alnum');
  205. ]]></programlisting>
  206. <para>
  207. Los nombres cortos son típicamente el nombre del filtro sin el
  208. prefijo. En el caso predeterminado, esto se refiere a sin el prefijo
  209. 'Zend_Filter_'. Además, la primera letra no necesita estar en
  210. mayúscula.
  211. </para>
  212. <note>
  213. <title>Usando clases de filtros personalizados</title>
  214. <para>
  215. Si tiene su propio conjunto de clases de filtro, puede
  216. informarle de ellas a <classname>Zend_Form_Element</classname> usando
  217. <code>addPrefixPath()</code>. Por ejemplo, si tiene filtros
  218. con el prefijo 'My_Filter', puede indicárselo a
  219. <classname>Zend_Form_Element</classname> de la siguiente manera:
  220. </para>
  221. <programlisting role="php"><![CDATA[
  222. $element->addPrefixPath('My_Filter', 'My/Filter/', 'filter');
  223. ]]></programlisting>
  224. <para>
  225. (Recuerde que el tercer argumento indica el cargador de plugin
  226. sobre el cual ha de ejecutarse la acción.)
  227. </para>
  228. </note>
  229. <para>
  230. Si en algún momento necesita un valor no filtrado, use el método
  231. <code>getUnfilteredValue()</code>:
  232. </para>
  233. <programlisting role="php"><![CDATA[
  234. $unfiltered = $element->getUnfilteredValue();
  235. ]]></programlisting>
  236. <para>
  237. Para mayor información sobre filtros, vea la <link linkend="zend.filter.introduction">documentación de
  238. Zend_Filter</link>.
  239. </para>
  240. <para>
  241. Métodos asociados con filtros incluyen:
  242. </para>
  243. <itemizedlist>
  244. <listitem><para>
  245. <code>addFilter($nameOfFilter, array $options = null)</code>
  246. </para></listitem>
  247. <listitem><para>
  248. <code>addFilters(array $filters)</code>
  249. </para></listitem>
  250. <listitem><para>
  251. <code>setFilters(array $filters)</code> (sobreescribe todos los
  252. filtros)
  253. </para></listitem>
  254. <listitem><para>
  255. <code>getFilter($name)</code> (recupera un objeto filtro por su
  256. nombre)
  257. </para></listitem>
  258. <listitem><para>
  259. <code>getFilters()</code> (recupera todos los filtros)
  260. </para></listitem>
  261. <listitem><para>
  262. <code>removeFilter($name)</code> (elimina un filtro por su
  263. nombre)
  264. </para></listitem>
  265. <listitem><para>
  266. <code>clearFilters()</code> (elimina todos los filtros)
  267. </para></listitem>
  268. </itemizedlist>
  269. </sect2>
  270. <sect2 id="zend.form.elements.validators">
  271. <title>Validadores</title>
  272. <para>
  273. Si sigue el mantra de seguridad "filtrar la entrada, escapar la
  274. salida" querrá validar ("filtrar la entrada") los datos de los
  275. formularios. En <classname>Zend_Form</classname> cada elemento contiene su
  276. propia cadena de validadores, consistente en validadores
  277. <code>Zend_Validate_*</code>.
  278. </para>
  279. <para>
  280. Los validadores pueden ser agregados de dos maneras:
  281. </para>
  282. <itemizedlist>
  283. <listitem><para>
  284. pasándolo en una instancia de validador específica
  285. </para></listitem>
  286. <listitem><para>
  287. proveyendo un nombre de validador – el correspondiente nombre
  288. corto o completo de clase
  289. </para></listitem>
  290. </itemizedlist>
  291. <para>
  292. Veamos algunos ejemplos:
  293. </para>
  294. <programlisting role="php"><![CDATA[
  295. // Instancia específica del validador:
  296. $element->addValidator(new Zend_Validate_Alnum());
  297. // El correspondiente nombre completo de la clase:
  298. $element->addValidator('Zend_Validate_Alnum');
  299. // Nombre corto del validador:
  300. $element->addValidator('Alnum');
  301. $element->addValidator('alnum');
  302. ]]></programlisting>
  303. <para>
  304. Los nombres cortos son típicamente el nombre del validador sin el
  305. prefijo. En el caso predeterminado, esto se refiere a sin el prefijo
  306. 'Zend_Validate_'. Además, la primera letra no necesita estar en
  307. mayúscula.
  308. </para>
  309. <note>
  310. <title>Usando clases de validación personalizadas</title>
  311. <para>
  312. Si tiene su propio conjunto de clases de validación, puede
  313. informarle de ellas a <classname>Zend_Form_Element</classname> usando
  314. <code>addPrefixPath()</code>. Por ejemplo, si tiene validadores
  315. con el prefijo 'My_Validator', puede indicárselo a
  316. <classname>Zend_Form_Element</classname> de la siguiente manera:
  317. </para>
  318. <programlisting role="php"><![CDATA[
  319. $element->addPrefixPath('My_Validator', 'My/Validator/', 'validate');
  320. ]]></programlisting>
  321. <para>
  322. (Recuerde que el tercer argumento indica el cargador de plugin
  323. sobre el cual ha de ejecutarse la acción.)
  324. </para>
  325. </note>
  326. <para>
  327. Si el fallo de un validador debe evitar validaciones posteriores,
  328. pase el boleano <code>true</code> como segundo parámetro:
  329. </para>
  330. <programlisting role="php"><![CDATA[
  331. $element->addValidator('alnum', true);
  332. ]]></programlisting>
  333. <para>
  334. Si está usando la cadena nombre para añadir el validador, y la clase
  335. del validador acepta argumentos para su constructor, puede pasarlos
  336. a el tercer parámetro de <code>addValidator()</code> como un
  337. array:
  338. </para>
  339. <programlisting role="php"><![CDATA[
  340. $element->addValidator('StringLength', false, array(6, 20));
  341. ]]></programlisting>
  342. <para>
  343. Los argumentos pasados de esta manera deben estar en el orden en el
  344. cual son definidos en el constructor. El ejemplo de arriba
  345. instanciará la clase <classname>Zend_Validate_StringLenth</classname> con los
  346. parámetros <code>$min</code> y <code>$max</code>:
  347. </para>
  348. <programlisting role="php"><![CDATA[
  349. $validator = new Zend_Validate_StringLength(6, 20);
  350. ]]></programlisting>
  351. <note>
  352. <title>Estipulando mensajes de error de validación personalizados</title>
  353. <para>
  354. Algunos desarrolladores querrán estipular mensajes de error
  355. personalizados para un validador. El argumento
  356. <code>$options</code> de
  357. <classname>Zend_Form_Element::addValidator()</classname> le permite
  358. hacerlo proporcionando la clave 'messages' y estableciendolos en
  359. un array de pares clave/valor para especificar las plantillas
  360. de mensaje. Necesitará conocer los códigos de error de los
  361. diferentes tipos de error de un validador en particular.
  362. </para>
  363. <para>
  364. Una opción mejor es usar <classname>Zend_Translate_Adapter</classname>
  365. con su formulario. Los códigos de error son automáticamente
  366. pasados al adaptador por el decorador Errors por defecto; puede
  367. especificar su propias cadenas de mensaje de error mediante la
  368. creación de traducciones para los varios códigos de error de
  369. sus validadores.
  370. </para>
  371. </note>
  372. <para>
  373. Puede también establecer varios validadores a la vez, usando
  374. <code>addValidators()</code>. Su uso básico es pasar una matriz de
  375. arrays, donde cada array contenga de 1 a 3 valores,
  376. correspondientes al constructor de <code>addValidator()</code>:
  377. </para>
  378. <programlisting role="php"><![CDATA[
  379. $element->addValidators(array(
  380. array('NotEmpty', true),
  381. array('alnum'),
  382. array('stringLength', false, array(6, 20)),
  383. ));
  384. ]]></programlisting>
  385. <para>
  386. Si quiere ser más detallado o explícito, puede utilizar las claves
  387. 'validator', 'breakChainOnFailure', y 'options' en el array:
  388. </para>
  389. <programlisting role="php"><![CDATA[
  390. $element->addValidators(array(
  391. array(
  392. 'validator' => 'NotEmpty',
  393. 'breakChainOnFailure' => true),
  394. array('validator' => 'alnum'),
  395. array(
  396. 'validator' => 'stringLength',
  397. 'options' => array(6, 20)),
  398. ));
  399. ]]></programlisting>
  400. <para>
  401. Este uso es bueno para ilustrar cómo puede configurar validadores
  402. en un archivo de configuración:
  403. </para>
  404. <programlisting role="ini"><![CDATA[
  405. element.validators.notempty.validator = "NotEmpty"
  406. element.validators.notempty.breakChainOnFailure = true
  407. element.validators.alnum.validator = "Alnum"
  408. element.validators.strlen.validator = "StringLength"
  409. element.validators.strlen.options.min = 6
  410. element.validators.strlen.options.max = 20
  411. ]]></programlisting>
  412. <para>
  413. Note que cada elemento tiene una clave, la necesite o no; esta es
  414. una limitación del uso de archivos de configuración -- pero también
  415. ayuda a hacer más explicito el para qué son usados los argumentos.
  416. Sólo recuerde que cualesquiera opciones del validador deben ser
  417. especificadas en orden.
  418. </para>
  419. <para>
  420. Para validar un elemento, pase el valor a
  421. <code>isValid()</code>:
  422. </para>
  423. <programlisting role="php"><![CDATA[
  424. if ($element->isValid($value)) {
  425. // válido
  426. } else {
  427. // no válido
  428. }
  429. ]]></programlisting>
  430. <note>
  431. <title>Validación operando en valores filtrados</title>
  432. <para>
  433. <classname>Zend_Form_Element::isValid()</classname>> siempre filtra los
  434. valores antes de la validación a través de la cadena de filtros.
  435. Vea <link linkend="zend.form.elements.filters">la sección de
  436. filtros</link> para más información.
  437. </para>
  438. </note>
  439. <note>
  440. <title>Contexto de validación</title>
  441. <para>
  442. <classname>Zend_Form_Element::isValid()</classname>> soporta un argumento
  443. adicional, <code>$context</code>.
  444. <classname>Zend_Form::isValid()</classname> pasa todo el conjunto de datos
  445. procesados a <code>$context</code> cuando valida un formulario,
  446. y <classname>Zend_Form_Element::isValid()</classname>>, a su vez, lo pasa a
  447. cada validador. Esto significa que puede escribir validadores
  448. que son conscientes de los datos pasados a otros elementos del
  449. formulario. Como ejemplo, considere un formulario de registro
  450. estándar que tiene campos para la contraseña y la confirmación
  451. de la contraseña; una validación sería que los dos campos
  452. coincidan. Este validador puede tener un aspecto como el
  453. siguiente:
  454. </para>
  455. <programlisting role="php"><![CDATA[
  456. class My_Validate_PasswordConfirmation extends Zend_Validate_Abstract
  457. {
  458. const NOT_MATCH = 'notMatch';
  459. protected $_messageTemplates = array(
  460. self::NOT_MATCH => 'Password confirmation does not match'
  461. );
  462. public function isValid($value, $context = null)
  463. {
  464. $value = (string) $value;
  465. $this->_setValue($value);
  466. if (is_array($context)) {
  467. if (isset($context['password_confirm'])
  468. && ($value == $context['password_confirm']))
  469. {
  470. return true;
  471. }
  472. } elseif (is_string($context) && ($value == $context)) {
  473. return true;
  474. }
  475. $this->_error(self::NOT_MATCH);
  476. return false;
  477. }
  478. }
  479. ]]></programlisting>
  480. </note>
  481. <para>
  482. Los validadores son procesados en orden. Cada validador es
  483. procesado, a menos que un validador creado con un valor true para
  484. <code>breakChainOnFailure</code> falle su validación. Asegúrese de
  485. especificar sus validadores en un orden razonable.
  486. </para>
  487. <para>
  488. Después de una validación fallida, puede recuperar los códigos y
  489. mensajes de error de la cadena del validador:
  490. </para>
  491. <programlisting role="php"><![CDATA[
  492. $errors = $element->getErrors();
  493. $messages = $element->getMessages();
  494. ]]></programlisting>
  495. <para>
  496. (Nota: los mensajes de error retornados son un array asociativo de
  497. pares código / mensaje de error.)
  498. </para>
  499. <para>
  500. En adición a los validadores, puede especificar que un elemento es
  501. necesario, usando <code>setRequired(true)</code>. Por defecto, esta
  502. bandera es false, lo que significa que pasará su cadena de
  503. validadores si ningún valor es pasado a <code>isValid()</code>.
  504. Puede modificar este comportamiento en un número de maneras:
  505. </para>
  506. <itemizedlist>
  507. <listitem>
  508. <para>
  509. Por defecto, cuando un elemento es requerido, una bandera,
  510. 'allowEmpty', también es true. Esto quiere decir que si un
  511. valor empty es evaluado pasándolo a <code>isValid()</code>,
  512. los validadores serán saltados. Puede intercalar esta
  513. bandera usando el método de acceso
  514. <code>setAllowEmpty($flag)</code>; cuando la bandera es
  515. false, si un valor es pasado, los validadores seguirán
  516. ejecutándose.
  517. </para>
  518. </listitem>
  519. <listitem>
  520. <para>
  521. Por defecto, si un elemento es requerido, pero no contiene
  522. un validador 'NotEmpty', <code>isValid()</code> añadirá uno
  523. en la cima de la pila, con la bandera
  524. <code>breakChainOnFailure</code> establecido. Esto hace que
  525. la bandera requerida tenga un significado semántico: si
  526. ningún valor es pasado, inmediatamente invalidamos el envío
  527. y se le notifica al usuario, e impedimos que otros
  528. validadores se ejecuten en lo que ya sabemos son datos
  529. inválidos.
  530. </para>
  531. <para>
  532. Si no quiere este comportamiento, puede desactivarlo pasando
  533. un valor false a
  534. <code>setAutoInsertNotEmptyValidator($flag)</code>; esto
  535. prevendrá a <code>isValid()</code> de colocar un validador
  536. 'NotEmpty' en la cadena de validaciones.
  537. </para>
  538. </listitem>
  539. </itemizedlist>
  540. <para>
  541. Para mayor información sobre validadores, vea la <link linkend="zend.validate.introduction">documentación de
  542. Zend_Validate</link>.
  543. </para>
  544. <note>
  545. <title>Usando Zend_Form_Elements como validador de propósito general</title>
  546. <para>
  547. <classname>Zend_Form_Element</classname> implementa
  548. <classname>Zend_Validate_Interface</classname>, significando un elemento
  549. puede también usarse como un validador en otro, cadenas de
  550. validación no relacionadas al formulario.
  551. </para>
  552. </note>
  553. <para>
  554. Métodos asociados con validación incluyen:
  555. </para>
  556. <itemizedlist>
  557. <listitem><para>
  558. <code>setRequired($flag)</code> y
  559. <code>isRequired()</code> permiten establecer y recuperar el
  560. estado de la bandera 'required'. Cuando se le asigna un
  561. booleano <code>true</code>, esta bandera requiere que el
  562. elemento esté presente en la información procesada por
  563. <classname>Zend_Form</classname>.
  564. </para></listitem>
  565. <listitem><para>
  566. <code>setAllowEmpty($flag)</code> y
  567. <code>getAllowEmpty()</code> permiten modificar el
  568. comportamiento de elementos opcionales (p.e., elementos
  569. donde la bandera required es false). Cuando la bandera
  570. 'allow empty' es true, valores vacíos no pasarán la cadena
  571. de validadores.
  572. </para></listitem>
  573. <listitem><para>
  574. <code>setAutoInsertNotEmptyValidator($flag)</code> permite
  575. especificar si realmente un validador 'NotEmpty' será
  576. añadido el inicio de la cadena de validaciones cuando un
  577. elemento es requerido. Por defecto, esta bandera es true.
  578. </para></listitem>
  579. <listitem><para>
  580. <code>addValidator($nameOrValidator, $breakChainOnFailure = false, array $options = null)</code>
  581. </para></listitem>
  582. <listitem><para>
  583. <code>addValidators(array $validators)</code>
  584. </para></listitem>
  585. <listitem><para>
  586. <code>setValidators(array $validators)</code> (sobreescribe todos los validadores)
  587. </para></listitem>
  588. <listitem><para>
  589. <code>getValidator($name)</code> (recupera un objeto validador por nombre)
  590. </para></listitem>
  591. <listitem><para>
  592. <code>getValidators()</code> (recupera todos los validadores)
  593. </para></listitem>
  594. <listitem><para>
  595. <code>removeValidator($name)</code> (elimina un validador por nombre)
  596. </para></listitem>
  597. <listitem><para>
  598. <code>clearValidators()</code> (elimina todos los validadores)
  599. </para></listitem>
  600. </itemizedlist>
  601. <sect3 id="zend.form.elements.validators.errors">
  602. <title>Errores de mensaje personalizados</title>
  603. <para>
  604. Alguna veces, querrá especificar uno o más mensajes de error para
  605. usarlos en lugar de los mensajes de error generados por los
  606. validadores adjuntos a los elementos. Adicionalmente, algunas
  607. veces usted mismo querrá marcar al elemento como inválido. A
  608. partir de 1.6.0, esta funcionalidad es posible vía los
  609. siguientes métodos.
  610. </para>
  611. <itemizedlist>
  612. <listitem><para>
  613. <code>addErrorMessage($message)</code>: añade un mensaje de
  614. error para mostrarlos en forma de errores de validación. Puede
  615. llamarlo más de una vez, y los nuevos mensajes nuevos son
  616. añadidos a la pila.
  617. </para></listitem>
  618. <listitem><para>
  619. <code>addErrorMessages(array $messages)</code>: añade
  620. múltiples mensajes de error para mostrarlos en forma de errores de
  621. validación.
  622. </para></listitem>
  623. <listitem><para>
  624. <code>setErrorMessages(array $messages)</code>: añade
  625. múltiples mensajes de error para mostrarlos en forma de errores de
  626. validación, sobreescribiendo todos los mensajes de error
  627. previamente establecidos.
  628. </para></listitem>
  629. <listitem><para>
  630. <code>getErrorMessages()</code>: recupera la lista de
  631. mensajes de error personalizados que fueron definidos.
  632. </para></listitem>
  633. <listitem><para>
  634. <code>clearErrorMessages()</code>: remueve todos los
  635. mensajes de error personalizados que hayan sido definidos.
  636. </para></listitem>
  637. <listitem><para>
  638. <code>markAsError()</code>: marca al elemento como que falló
  639. la validación.
  640. </para></listitem>
  641. <listitem><para>
  642. <code>hasErrors()</code>: determina si el elemento ha
  643. fallado la validación o ha sido marcado como inválido.
  644. </para></listitem>
  645. <listitem><para>
  646. <code>addError($message)</code>: añade un mensaje a la pila
  647. de mensaje de error personalizados y marca al elemento como
  648. inválido.
  649. </para></listitem>
  650. <listitem><para>
  651. <code>addErrors(array $messages)</code>: añade varios
  652. mensajes a la pila de mensajes de error personalizados y
  653. marca al elemento como inválido.
  654. </para></listitem>
  655. <listitem><para>
  656. <code>setErrors(array $messages)</code>: sobreescribe el
  657. mensaje de error personalizado en la pila con los mensajes
  658. previstos y marca al elemento como inválido.
  659. </para></listitem>
  660. </itemizedlist>
  661. <para>
  662. Todos los errores establecidos de este modo pueden ser
  663. traducidos. Adicionalmente, puede insertar el marcador "%value%"
  664. para representar el valor del elemento; este valor actual del
  665. elemento será sustituido cuando el mensaje de error sea
  666. recuperado.
  667. </para>
  668. </sect3>
  669. </sect2>
  670. <sect2 id="zend.form.elements.decorators">
  671. <title>Decoradores</title>
  672. <para>
  673. Una dolencia particular para muchos desarrolladores web es la creación
  674. del XHTML para formularios por ellos mismos. Para cada elemento, el
  675. desarrollador necesita crear la marcación para el elemento mismo,
  676. comúnmente una etiqueta (label), y, si son amables con sus usuarios,
  677. la marcación para mostrar mensajes de errores de validación. Cuanto
  678. más elementos en una página, menos trivial se convierte esta tarea.
  679. </para>
  680. <para>
  681. <classname>Zend_Form_Element</classname> intenta resolver este problema mediante
  682. el uso de "decoradores". Los decoradores son clases simples que tienen
  683. métodos de acceso al elemento y métodos para generar el contenido. Para
  684. obtener mayor información sobre cómo trabajan los decoradores, consulte
  685. por favor la sección sobre
  686. <link linkend="zend.form.decorators">Zend_Form_Decorator</link>.
  687. </para>
  688. <para>
  689. Los decoradores usados por defecto por
  690. <classname>Zend_Form_Element</classname> son:
  691. </para>
  692. <itemizedlist>
  693. <listitem><para>
  694. <emphasis>ViewHelper</emphasis>: especifica un view helper que
  695. usar para general el elemento. El atributo 'helper' del elemento
  696. puede usarse para especificar qué auxiliar vista usar. Por
  697. defecto, <classname>Zend_Form_Element</classname> especifica el auxiliar
  698. vista 'formText', pero cada subclase especifica diferentes
  699. auxiliares.
  700. </para></listitem>
  701. <listitem><para>
  702. <emphasis>Errors</emphasis>: añade mensajes de error al elemento
  703. usando <code>Zend_View_Helper_FormErrors</code>. Si no está
  704. presente, no se añade nada.
  705. </para></listitem>
  706. <listitem><para>
  707. <emphasis>Description</emphasis>: añade la descripción del
  708. elemento. Si no está presente, no se añade nada. Por defecto, la
  709. descripción es generada dentro de una etiqueta &lt;p&gt; con un
  710. class 'description'.
  711. </para></listitem>
  712. <listitem><para>
  713. <emphasis>HtmlTag</emphasis>: envuelve el elemento y los errores
  714. en una etiqueta HTML &lt;dd&gt;.
  715. </para></listitem>
  716. <listitem><para>
  717. <emphasis>Label</emphasis>: añade al comienzo una etiqueta al
  718. elemento usando <code>Zend_View_Helper_FormLabel</code>, y
  719. envolviéndola en una etiqueta &lt;dt&gt;. Si ninguna etiqueta es
  720. provista, solo la etiqueta de la definición es generada.
  721. </para></listitem>
  722. </itemizedlist>
  723. <note>
  724. <title>Decoradores por defecto no necesitan ser cargados</title>
  725. <para>
  726. Por defecto, los decoradores por defecto son cargados durante la
  727. inicialización del objeto. Puede deshabilitar esto pasando la
  728. opción 'disableLoadDefaultDecorators' al constructor:
  729. </para>
  730. <programlisting role="php"><![CDATA[
  731. $element = new Zend_Form_Element('foo',
  732. array('disableLoadDefaultDecorators' =>
  733. true)
  734. );
  735. ]]></programlisting>
  736. <para>
  737. Esta opción puede ser combinada junto con cualquier otra opción que
  738. pase, ya sea como un array de opciones o en un objeto
  739. <code>Zend_Config</code>.
  740. </para>
  741. </note>
  742. <para>
  743. Ya que el orden en el cual los decoradores son registrados importa
  744. -- el primer decorador registrado es ejecutado primero -- necesitará
  745. estar seguro de registrar sus decoradores en el orden apropiado, o
  746. asegurarse de que estableció las opciones de colocación en el modo apropiado. Por
  747. dar un ejemplo, aquí esta el código que registran los decoradores
  748. por defecto:
  749. </para>
  750. <programlisting role="php"><![CDATA[
  751. $this->addDecorators(array(
  752. array('ViewHelper'),
  753. array('Errors'),
  754. array('Description', array('tag' => 'p', 'class' => 'description')),
  755. array('HtmlTag', array('tag' => 'dd')),
  756. array('Label', array('tag' => 'dt')),
  757. ));
  758. ]]></programlisting>
  759. <para>
  760. El contenido inicial es creado por el decorador 'ViewHelper', que
  761. crea el propio elemento. En seguida, el decorador 'Errors' consulta
  762. los mensajes de error del elemento, y, si hay alguno presente, los
  763. pasa al auxiliar vista 'FormErrors' para mostrarlos. Si una
  764. descripción está presente, el decorador 'Description' añadirá
  765. un párrafo con class 'description' conteniendo el texto descriptivo
  766. para el contenido agregado. El siguiente decorador, 'HtmlTag',
  767. envuelve al elemento, los errores, y la descripción en una etiqueta
  768. HTML &lt;dd&gt;. Finalmente, el último decorador, 'label', recupera
  769. la etiqueta del elemento y la pasa al auxiliar vista 'FormLabel',
  770. envolviéndolo en una etiqueta &lt;dt&gt;; por default el valor es
  771. añadido al inicio del contenido. El resultado de la salida
  772. básicamente se ve así:
  773. </para>
  774. <programlisting role="html"><![CDATA[
  775. <dt><label for="foo" class="optional">Foo</label></dt>
  776. <dd>
  777. <input type="text" name="foo" id="foo" value="123" />
  778. <ul class="errors">
  779. <li>"123" is not an alphanumeric value</li>
  780. </ul>
  781. <p class="description">
  782. This is some descriptive text regarding the element.
  783. </p>
  784. </dd>
  785. ]]></programlisting>
  786. <para>
  787. Para más información sobre decoradores, lea la <link linkend="zend.form.decorators"> sección de Zend_Form_Decorator</link>.
  788. </para>
  789. <note>
  790. <title>Usando múltiples decoradores al mismo tiempo</title>
  791. <para>
  792. Internamente, <classname>Zend_Form_Element</classname> utiliza una clase
  793. decorador como mecanismo de búsqueda para la recuperación de
  794. decoradores. Como resultado, no puede registrar múltiples
  795. decoradores del mismo tipo; decoradores subsecuentes
  796. simplemente sobreescribirán aquellos que ya existían.
  797. </para>
  798. <para>
  799. Para evitar esto, puede usar <emphasis>alias</emphasis>. En
  800. lugar de pasar un decorador o nombre de decorador como primer
  801. argumento a <code>addDecorator()</code>, pase una matriz con un
  802. solo elemento, con el alias apuntando al nombre o objeto
  803. decorador:
  804. </para>
  805. <programlisting role="php"><![CDATA[
  806. // Alias a 'FooBar':
  807. $element->addDecorator(array('FooBar' => 'HtmlTag'),
  808. array('tag' => 'div'));
  809. // Y recuperandolo posteriormente:
  810. $decorator = $element->getDecorator('FooBar');
  811. ]]></programlisting>
  812. <para>
  813. En los métodos <code>addDecorators()</code> y
  814. <code>setDecorators()</code>, necesitará pasar la opción
  815. 'decorator' en la matriz representando el decorador:
  816. </para>
  817. <programlisting role="php"><![CDATA[
  818. // Y dos decoradores 'HtmlTag', 'FooBar' como alias:
  819. $element->addDecorators(
  820. array('HtmlTag', array('tag' => 'div')),
  821. array(
  822. 'decorator' => array('FooBar' => 'HtmlTag'),
  823. 'options' => array('tag' => 'dd')
  824. ),
  825. );
  826. // Y recuperándolos posteriormente:
  827. $htmlTag = $element->getDecorator('HtmlTag');
  828. $fooBar = $element->getDecorator('FooBar');
  829. ]]></programlisting>
  830. </note>
  831. <para>
  832. Métodos asociados con decoradores incluyen:
  833. </para>
  834. <itemizedlist>
  835. <listitem><para>
  836. <code>addDecorator($nameOrDecorator, array $options = null)</code>
  837. </para></listitem>
  838. <listitem><para>
  839. <code>addDecorators(array $decorators)</code>
  840. </para></listitem>
  841. <listitem><para>
  842. <code>setDecorators(array $decorators)</code> (sobreescribe
  843. todos los decoradores)
  844. </para></listitem>
  845. <listitem><para>
  846. <code>getDecorator($name)</code> (recupera un objeto decorador
  847. por su nombre)
  848. </para></listitem>
  849. <listitem><para>
  850. <code>getDecorators()</code> (recupera todos los decoradores)
  851. </para></listitem>
  852. <listitem><para>
  853. <code>removeDecorator($name)</code> (elimina un decorador por su
  854. nombre)
  855. </para></listitem>
  856. <listitem><para>
  857. <code>clearDecorators()</code> (elimina todos los decoradores)
  858. </para></listitem>
  859. </itemizedlist>
  860. <para>
  861. <classname>Zend_Form_Element</classname> también utiliza la sobrecarga para
  862. permitir generar decoradores específicos. <code>__call()</code>
  863. interceptará métodos que comiencen con el texto 'render' y utilizará
  864. el resto del nombre del método para buscar un decorador; si se
  865. encuentra, entonces será generado <emphasis>sólo ese</emphasis>
  866. decorador. Cualquier argumento pasado al llamado del método será
  867. usado como contenido para pasar al método <code>render()</code> del
  868. decorador. Como ejemplo:
  869. </para>
  870. <programlisting role="php"><![CDATA[
  871. // Genera solo el decorador ViewHelper:
  872. echo $element->renderViewHelper();
  873. // Genera solo el decorador HtmlTag, pasándole contenido:
  874. echo $element->renderHtmlTag("This is the html tag content");
  875. ]]></programlisting>
  876. <para>
  877. Si el decorador no existe, una excepción es lanzada.
  878. </para>
  879. </sect2>
  880. <sect2 id="zend.form.elements.metadata">
  881. <title>Metadatos y atributos</title>
  882. <para>
  883. <classname>Zend_Form_Element</classname> manipula una variedad de atributos y
  884. medatados del elemento. Atributos básicos incluyen:
  885. </para>
  886. <itemizedlist>
  887. <listitem><para>
  888. <emphasis>name</emphasis>: el nombre del elemento. Emplea los
  889. métodos de acceso <code>setName()</code> y <code>getName()</code>.
  890. </para></listitem>
  891. <listitem><para>
  892. <emphasis>label</emphasis>: la etiqueta del elemento. Emplea los
  893. métodos de acceso <code>setLabel()</code> y <code>getLabel()</code>.
  894. </para></listitem>
  895. <listitem><para>
  896. <emphasis>order</emphasis>: el índice en el cual los elementos
  897. deben ir mostrándose en el formulario. Emplea los métodos de
  898. acceso <code>setOrder()</code> y <code>getOrder()</code>.
  899. </para></listitem>
  900. <listitem><para>
  901. <emphasis>value</emphasis>: El valor del elemento actual. Emplea
  902. los métodos de acceso <code>setValue()</code> y
  903. <code>getValue()</code>.
  904. </para></listitem>
  905. <listitem><para>
  906. <emphasis>description</emphasis>: una descripción del elemento;
  907. a menudo utilizada para proveer un tooltip o ayuda contextual
  908. con javascript describiendo el propósito del elemento. Emplea
  909. los métodos de acceso <code>setDescription()</code> y
  910. <code>getDescription()</code>.
  911. </para></listitem>
  912. <listitem><para>
  913. <emphasis>required</emphasis>: bandera que indica si un elemento
  914. es requerido o no cuando se efectúa la validación del
  915. formulario. Emplea los métodos de acceso
  916. <code>setRequired()</code> y <code>getRequired()</code>. Esta
  917. bandera es false por defecto.
  918. </para></listitem>
  919. <listitem><para>
  920. <emphasis>allowEmpty</emphasis>: bandera indicando si un
  921. elemento no-requerido (opcional) debe intentar validar o no
  922. valores vacíos. Cuando es true, y la bandera required es false,
  923. valores vacíos no pasarán la cadena de validación, y se supone
  924. verdadero. Emplea los métodos de acceso
  925. <code>setAllowEmpty()</code> y <code>getAllowEmpty()</code>.
  926. Esta bandera es true por defecto.
  927. </para></listitem>
  928. <listitem><para>
  929. <emphasis>autoInsertNotEmptyValidator</emphasis>: bandera
  930. indicando insertar o no un validador 'NotEmpty' cuando un
  931. elemento es requerido. Por defecto, esta bandera es true.
  932. Establezca la bandera con
  933. <code>setAutoInsertNotEmptyValidator($flag)</code> y determine
  934. el valor con <code>autoInsertNotEmptyValidator()</code>.
  935. </para></listitem>
  936. </itemizedlist>
  937. <para>
  938. Los elementos del formulario pueden requerir metainformación
  939. adicional. Para elementos XHTML del formuladio, por ejemplo, puede
  940. querer especificar atributos como el class o id. Para facilitar esto
  941. hay un conjunto de métodos de acceso:
  942. </para>
  943. <itemizedlist>
  944. <listitem><para>
  945. <emphasis>setAttrib($name, $value)</emphasis>: añade un atributo
  946. </para></listitem>
  947. <listitem><para>
  948. <emphasis>setAttribs(array $attribs)</emphasis>: como
  949. addAttribs(), pero sobreescribiendo
  950. </para></listitem>
  951. <listitem><para>
  952. <emphasis>getAttrib($name)</emphasis>: recupera el valor de solo
  953. un atributo
  954. </para></listitem>
  955. <listitem><para>
  956. <emphasis>getAttribs()</emphasis>: recupera todos los atributos
  957. como pares clave/valor
  958. </para></listitem>
  959. </itemizedlist>
  960. <para>
  961. La mayoría de las veces, como sea, puede simplemente acceder a ellos
  962. como propiedades de objeto, ya que <classname>Zend_Form_Element</classname>
  963. utiliza la sobrecarga para facilitar el acceso a ellos:
  964. </para>
  965. <programlisting role="php"><![CDATA[
  966. // Equivalente a $element->setAttrib('class', 'text'):
  967. $element->class = 'text;
  968. ]]></programlisting>
  969. <para>
  970. Por defecto, todos los atributos son pasados al auxiliar vista usado
  971. por el elemento durante la generación, y generados como atributos de
  972. la etiqueta del elemento.
  973. </para>
  974. </sect2>
  975. <sect2 id="zend.form.elements.standard">
  976. <title>Elementos Estándar</title>
  977. <para>
  978. <classname>Zend_Form</classname> contiene un buen número de elementos
  979. estándar; por favor lea el capítulo <link linkend="zend.form.standardElements">Elementos Estándar</link> para
  980. todos los detalles.
  981. </para>
  982. </sect2>
  983. <sect2 id="zend.form.elements.methods">
  984. <title>Métodos de Zend_Form_Element</title>
  985. <para>
  986. <classname>Zend_Form_Element</classname> tiene muchos, muchos métodos. Lo que
  987. sigue es un sumario de sus funciones, agrupados por tipo:
  988. </para>
  989. <itemizedlist>
  990. <listitem><para>Configuración:</para>
  991. <itemizedlist>
  992. <listitem><para><code>setOptions(array $options)</code></para></listitem>
  993. <listitem><para><code>setConfig(Zend_Config $config)</code></para></listitem>
  994. </itemizedlist>
  995. </listitem>
  996. <listitem><para>I18n:</para>
  997. <itemizedlist>
  998. <listitem><para><code>setTranslator(Zend_Translate_Adapter $translator = null)</code></para></listitem>
  999. <listitem><para><code>getTranslator()</code></para></listitem>
  1000. <listitem><para><code>setDisableTranslator($flag)</code></para></listitem>
  1001. <listitem><para><code>translatorIsDisabled()</code></para></listitem>
  1002. </itemizedlist>
  1003. </listitem>
  1004. <listitem><para>Propiedades:</para>
  1005. <itemizedlist>
  1006. <listitem><para><code>setName($name)</code></para></listitem>
  1007. <listitem><para><code>getName()</code></para></listitem>
  1008. <listitem><para><code>setValue($value)</code></para></listitem>
  1009. <listitem><para><code>getValue()</code></para></listitem>
  1010. <listitem><para><code>getUnfilteredValue()</code></para></listitem>
  1011. <listitem><para><code>setLabel($label)</code></para></listitem>
  1012. <listitem><para><code>getLabel()</code></para></listitem>
  1013. <listitem><para><code>setDescription($description)</code></para></listitem>
  1014. <listitem><para><code>getDescription()</code></para></listitem>
  1015. <listitem><para><code>setOrder($order)</code></para></listitem>
  1016. <listitem><para><code>getOrder()</code></para></listitem>
  1017. <listitem><para><code>setRequired($flag)</code></para></listitem>
  1018. <listitem><para><code>getRequired()</code></para></listitem>
  1019. <listitem><para><code>setAllowEmpty($flag)</code></para></listitem>
  1020. <listitem><para><code>getAllowEmpty()</code></para></listitem>
  1021. <listitem><para><code>setAutoInsertNotEmptyValidator($flag)</code></para></listitem>
  1022. <listitem><para><code>autoInsertNotEmptyValidator()</code></para></listitem>
  1023. <listitem><para><code>setIgnore($flag)</code></para></listitem>
  1024. <listitem><para><code>getIgnore()</code></para></listitem>
  1025. <listitem><para><code>getType()</code></para></listitem>
  1026. <listitem><para><code>setAttrib($name, $value)</code></para></listitem>
  1027. <listitem><para><code>setAttribs(array $attribs)</code></para></listitem>
  1028. <listitem><para><code>getAttrib($name)</code></para></listitem>
  1029. <listitem><para><code>getAttribs()</code></para></listitem>
  1030. </itemizedlist>
  1031. </listitem>
  1032. <listitem><para>Cargadores y rutas de plugin:</para>
  1033. <itemizedlist>
  1034. <listitem><para><code>setPluginLoader(Zend_Loader_PluginLoader_Interface $loader, $type)</code></para></listitem>
  1035. <listitem><para><code>getPluginLoader($type)</code></para></listitem>
  1036. <listitem><para><code>addPrefixPath($prefix, $path, $type = null)</code></para></listitem>
  1037. <listitem><para><code>addPrefixPaths(array $spec)</code></para></listitem>
  1038. </itemizedlist>
  1039. </listitem>
  1040. <listitem><para>Validación:</para>
  1041. <itemizedlist>
  1042. <listitem><para><code>addValidator($validator, $breakChainOnFailure = false, $options = array())</code></para></listitem>
  1043. <listitem><para><code>addValidators(array $validators)</code></para></listitem>
  1044. <listitem><para><code>setValidators(array $validators)</code></para></listitem>
  1045. <listitem><para><code>getValidator($name)</code></para></listitem>
  1046. <listitem><para><code>getValidators()</code></para></listitem>
  1047. <listitem><para><code>removeValidator($name)</code></para></listitem>
  1048. <listitem><para><code>clearValidators()</code></para></listitem>
  1049. <listitem><para><code>isValid($value, $context = null)</code></para></listitem>
  1050. <listitem><para><code>getErrors()</code></para></listitem>
  1051. <listitem><para><code>getMessages()</code></para></listitem>
  1052. </itemizedlist>
  1053. </listitem>
  1054. <listitem><para>Filtros:</para>
  1055. <itemizedlist>
  1056. <listitem><para><code>addFilter($filter, $options = array())</code></para></listitem>
  1057. <listitem><para><code>addFilters(array $filters)</code></para></listitem>
  1058. <listitem><para><code>setFilters(array $filters)</code></para></listitem>
  1059. <listitem><para><code>getFilter($name)</code></para></listitem>
  1060. <listitem><para><code>getFilters()</code></para></listitem>
  1061. <listitem><para><code>removeFilter($name)</code></para></listitem>
  1062. <listitem><para><code>clearFilters()</code></para></listitem>
  1063. </itemizedlist>
  1064. </listitem>
  1065. <listitem><para>Generación:</para>
  1066. <itemizedlist>
  1067. <listitem><para><code>setView(Zend_View_Interface $view = null)</code></para></listitem>
  1068. <listitem><para><code>getView()</code></para></listitem>
  1069. <listitem><para><code>addDecorator($decorator, $options = null)</code></para></listitem>
  1070. <listitem><para><code>addDecorators(array $decorators)</code></para></listitem>
  1071. <listitem><para><code>setDecorators(array $decorators)</code></para></listitem>
  1072. <listitem><para><code>getDecorator($name)</code></para></listitem>
  1073. <listitem><para><code>getDecorators()</code></para></listitem>
  1074. <listitem><para><code>removeDecorator($name)</code></para></listitem>
  1075. <listitem><para><code>clearDecorators()</code></para></listitem>
  1076. <listitem><para><code>render(Zend_View_Interface $view = null)</code></para></listitem>
  1077. </itemizedlist>
  1078. </listitem>
  1079. </itemizedlist>
  1080. </sect2>
  1081. <sect2 id="zend.form.elements.config">
  1082. <title>Configuración</title>
  1083. <para>
  1084. El constructor de <classname>Zend_Form_Element</classname> acepta tanto una
  1085. matriz de opciones como un objeto <code>Zend_Config</code>
  1086. conteniendo opciones, y esto puede configurarse usando
  1087. <code>setOptions()</code> o <code>setConfig()</code>. Hablando de
  1088. manera general, las claves son nombradas de la siguiente manera:
  1089. </para>
  1090. <itemizedlist>
  1091. <listitem><para>
  1092. Si 'set' + clave se refiere a un método de
  1093. <classname>Zend_Form_Element</classname>, entonces el valor provisto será
  1094. pasado a el método.
  1095. </para></listitem>
  1096. <listitem><para>
  1097. De otra manera, el valor será usado para establecer un atributo.
  1098. </para></listitem>
  1099. </itemizedlist>
  1100. <para>
  1101. Excepciones a la regla incluyen las siguientes:
  1102. </para>
  1103. <itemizedlist>
  1104. <listitem><para>
  1105. <code>prefixPath</code> será pasado a
  1106. <code>addPrefixPaths()</code>
  1107. </para></listitem>
  1108. <listitem>
  1109. <para>
  1110. Los siguientes setters no pueden establecerse de esta manera:
  1111. </para>
  1112. <itemizedlist>
  1113. <listitem><para>
  1114. <code>setAttrib</code> (aunque
  1115. <code>setAttribs</code> <emphasis>funcionará</emphasis>
  1116. </para></listitem>
  1117. <listitem><para><code>setConfig</code></para></listitem>
  1118. <listitem><para><code>setOptions</code></para></listitem>
  1119. <listitem><para><code>setPluginLoader</code></para></listitem>
  1120. <listitem><para><code>setTranslator</code></para></listitem>
  1121. <listitem><para><code>setView</code></para></listitem>
  1122. </itemizedlist>
  1123. </listitem>
  1124. </itemizedlist>
  1125. <para>
  1126. Como ejemplo, aquí esta un archivo de configuración pasado para
  1127. cada tipo de dato configurable:
  1128. </para>
  1129. <programlisting role="ini"><![CDATA[
  1130. [element]
  1131. name = "foo"
  1132. value = "foobar"
  1133. label = "Foo:"
  1134. order = 10
  1135. required = true
  1136. allowEmpty = false
  1137. autoInsertNotEmptyValidator = true
  1138. description = "Foo elements are for examples"
  1139. ignore = false
  1140. attribs.id = "foo"
  1141. attribs.class = "element"
  1142. ; sets 'onclick' attribute
  1143. onclick = "autoComplete(this, '/form/autocomplete/element')"
  1144. prefixPaths.decorator.prefix = "My_Decorator"
  1145. prefixPaths.decorator.path = "My/Decorator/"
  1146. disableTranslator = 0
  1147. validators.required.validator = "NotEmpty"
  1148. validators.required.breakChainOnFailure = true
  1149. validators.alpha.validator = "alpha"
  1150. validators.regex.validator = "regex"
  1151. validators.regex.options.pattern = "/^[A-F].*/$"
  1152. filters.ucase.filter = "StringToUpper"
  1153. decorators.element.decorator = "ViewHelper"
  1154. decorators.element.options.helper = "FormText"
  1155. decorators.label.decorator = "Label"
  1156. ]]></programlisting>
  1157. </sect2>
  1158. <sect2 id="zend.form.elements.custom">
  1159. <title>Elementos personalizados</title>
  1160. <para>
  1161. Usted puede crear sus propios elementos personalizados simplemente
  1162. extendiendo la clase <classname>Zend_Form_Element</classname>. Las razones
  1163. comunes para hacer esto incluyen:
  1164. </para>
  1165. <itemizedlist>
  1166. <listitem><para>
  1167. Elementos que comparten validadores y/o filtros comunes
  1168. </para></listitem>
  1169. <listitem><para>
  1170. Elementos que tienen decoradores con funcionalidad personalizada
  1171. </para></listitem>
  1172. </itemizedlist>
  1173. <para>
  1174. Hay dos métodos típicamente usados para extender un elemento:
  1175. <code>init()</code>, el cual puede usarse para añadir una lógica de
  1176. inicialización personalizada a su elemento, y
  1177. <code>loadDefaultDecorators()</code>, el cual puede usarse para
  1178. establecer una lista de decoradores usados por su elemento de manera
  1179. predeterminada.
  1180. </para>
  1181. <para>
  1182. Como un ejemplo, digamos que todos los elementos de tipo texto en un
  1183. formulario que está creando, necesitan ser filtrados con
  1184. <code>StringTrim</code>, validados con una expresión regular, y que
  1185. quiere usar un decorador personalizado que ha creado para
  1186. mostrarlos, 'My_Decorator_TextItem'; adicionalmente, tiene un número
  1187. de atributos estándars, incluyendo 'size', 'maxLength', y 'class'
  1188. que quisiera especificar. Puede definir un elemento tal como sigue:
  1189. </para>
  1190. <programlisting role="php"><![CDATA[
  1191. class My_Element_Text extends Zend_Form_Element
  1192. {
  1193. public function init()
  1194. {
  1195. $this->addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator')
  1196. ->addFilters('StringTrim')
  1197. ->addValidator('Regex', false, array('/^[a-z0-9]{6,}$/i'))
  1198. ->addDecorator('TextItem')
  1199. ->setAttrib('size', 30)
  1200. ->setAttrib('maxLength', 45)
  1201. ->setAttrib('class', 'text');
  1202. }
  1203. }
  1204. ]]></programlisting>
  1205. <para>
  1206. Entonces puede informar a su objeto formulario acerca del prefijo de
  1207. ruta para elementos de ese tipo, y comenzar creando elementos:
  1208. </para>
  1209. <programlisting role="php"><![CDATA[
  1210. $form->addPrefixPath('My_Element', 'My/Element/', 'element')
  1211. ->addElement('foo', 'text');
  1212. ]]></programlisting>
  1213. <para>
  1214. El elemento 'foo' será ahora del tipo <code>My_Element_Text</code>,
  1215. y mostrará el comportamiento que ha especificado.
  1216. </para>
  1217. <para>
  1218. Otro método que puede querer sobreescribir cuando extienda
  1219. <classname>Zend_Form_Element</classname> es el método
  1220. <code>loadDefaultDecorators()</code>. Este método carga
  1221. condicionalmente un grupo de decoradores predefinidos para su
  1222. elemento; puede querer sustituir su propio decorador en su clase
  1223. extendida:
  1224. </para>
  1225. <programlisting role="php"><![CDATA[
  1226. class My_Element_Text extends Zend_Form_Element
  1227. {
  1228. public function loadDefaultDecorators()
  1229. {
  1230. $this->addDecorator('ViewHelper')
  1231. ->addDecorator('DisplayError')
  1232. ->addDecorator('Label')
  1233. ->addDecorator('HtmlTag',
  1234. array('tag' => 'div', 'class' => 'element'));
  1235. }
  1236. }
  1237. ]]></programlisting>
  1238. <para>
  1239. Hay muchas maneras de personalizar elementos; asegúrese de leer la
  1240. documentación de la API de <classname>Zend_Form_Element</classname> para
  1241. conocer todos los métodos disponibles.
  1242. </para>
  1243. </sect2>
  1244. </sect1>
  1245. <!--
  1246. vim:se ts=4 sw=4 tw=80 ai et:
  1247. -->