Zend_Form-Elements.xml 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15207 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.form.elements">
  5. <title>Erstellen von Form Elementen mit Hilfe von Zend_Form_Element</title>
  6. <para>
  7. Ein Formular ist aus Elementen gemacht, die typischerweise mit einer HTML Form Eingabe
  8. korrespondieren. <classname>Zend_Form_Element</classname> kapselt einzelne Formularelemente mit den folgenden
  9. Bereichen die erfüllt werden sollen:
  10. </para>
  11. <itemizedlist>
  12. <listitem>
  13. <para>
  14. Prüfung (ist der übertragene Wert gültig?)
  15. </para>
  16. <itemizedlist>
  17. <listitem><para>Fangen von Fehlercodes und Nachrichten von Prüfungen</para></listitem>
  18. </itemizedlist>
  19. </listitem>
  20. <listitem><para>
  21. Filtern (wie wird das Element in Anführungsstriche gesetzt oder normalisiert bevor die
  22. Prüfung stattfinden und/oder für die Ausgabe?)
  23. </para></listitem>
  24. <listitem><para>
  25. Darstellung (wie wird das Element angezeigt?)
  26. </para></listitem>
  27. <listitem><para>
  28. Metadaten und Attribute (welche Informationen qualifizieren das Element näher?)
  29. </para></listitem>
  30. </itemizedlist>
  31. <para>
  32. Die Basisklasse, <classname>Zend_Form_Element</classname>, hat begründete Standardwerte für viele
  33. Fälle, aber es ist am besten die Klasse zu erweitern für oft verwendete speziell
  34. benötigte Elemente. Zusätzlich wird Zend Framework mit einer Anzahl an Standard
  35. XHTML Elementen ausgeliefert; über diese kann im
  36. <link linkend="zend.form.standardElements">Kapitel über Standard Elemente</link>
  37. nachgelesen werden.
  38. </para>
  39. <sect2 id="zend.form.elements.loaders">
  40. <title>Plugin Loader</title>
  41. <para>
  42. <classname>Zend_Form_Element</classname> verwendet
  43. <link linkend="zend.loader.pluginloader">Zend_Loader_PluginLoader</link> um es
  44. Entwicklern zu erlauben Orte für alternative Prüfungen, Filter und Dekoratoren zu
  45. definieren. Jeder hat seinen eigenen Plugin Loader assoziiert, und generelle
  46. Zugriffspunkte werden verwendet um jeden zu empfangen oder zu ändern.
  47. </para>
  48. <para>
  49. Die folgenden Ladetypen werden mit den verschiedenen Plugin Loader Methoden verwendet:
  50. 'validate', 'filter', und 'decorator'. Die Typnamen sind unabhängig von der
  51. Schreibweise.
  52. </para>
  53. <para>
  54. Die Methoden die für die Interaktion mit Plugin Loadern verwendet werden, sind die
  55. folgenden:
  56. </para>
  57. <itemizedlist>
  58. <listitem><para>
  59. <code>setPluginLoader($loader, $type)</code>: <code>$loader</code> ist das
  60. Plugin Loader Objekt selbst, während <code>$type</code> eine der oben spezifizierten
  61. Typen ist. Das setzt den Plugin Loader für den gegebenen Typ auf das neu
  62. spezifizierte Loader Objekt.
  63. </para></listitem>
  64. <listitem><para>
  65. <code>getPluginLoader($type)</code>: Empfängt den mit <code>$type</code>
  66. assoziierten Plugin Loader.
  67. </para></listitem>
  68. <listitem><para>
  69. <code>addPrefixPath($prefix, $path, $type = null)</code>: Fügt eine Präfix/Pfad
  70. Assoziation hinzu, Wenn <code>$type</code> null ist, wird versucht den Pfad zu
  71. allen Loadern hinzuzufügen durch anhängen des Präfix von jedem "_Validate",
  72. "_Filter", und "_Decorator"; und anhängen des Pfades an "Validate/", "Filter/",
  73. und "Decorator/". Wenn alle extra Formular Elementklassen unter einer üblichen
  74. Hirarchie stehen, ist das die bequemste Methode für das Setzen von grundsätzlichen
  75. Präfixen.
  76. </para></listitem>
  77. <listitem><para>
  78. <code>addPrefixPaths(array $spec)</code>: Erlaubt es viele Pfade auf einmal zu
  79. einem oder mehreren Plugin Loadern hinzuzufügen. Sie erwartet das jedes
  80. Arrayelement ein Array mit den Sclüsseln 'path', 'prefix' und 'type' ist.
  81. </para></listitem>
  82. </itemizedlist>
  83. <para>
  84. Eigene Prüfungen, Filter und Dekoratoren sind ein einfacher Weg um Funktionalität zwischen
  85. Forms zu teilen und eigene Funktionalitäten zu kapseln.
  86. </para>
  87. <example id="zend.form.elements.loaders.customLabel">
  88. <title>Eigenes Label</title>
  89. <para>
  90. Ein üblicher Verwendungszweck ist es Ersetzungen für Standardklassen anzubieten.
  91. Zum Beispiel wenn man eine andere Implementation des 'Label' Dekorators anbieten
  92. will -- zum Beispiel um immer einen Bindestrich anzufügen -- dann könnte man einen
  93. eigenen 'Label' Dekorator mit einem eigenen Klassenpräfix erstellen, und diesen
  94. zum eigenen Präfix Pfad hinzufügen.
  95. </para>
  96. <para>
  97. Beginnen wir mit einem eigenen Label Dekorator. Wir geben ihm den Klassenpräfix
  98. "My_Decorator", und die Klasse selbst wird in der Datei "My/Decorator/Label.php"
  99. sein.
  100. </para>
  101. <programlisting role="php"><![CDATA[
  102. class My_Decorator_Label extends Zend_Form_Decorator_Abstract
  103. {
  104. protected $_placement = 'PREPEND';
  105. public function render($content)
  106. {
  107. if (null === ($element = $this->getElement())) {
  108. return $content;
  109. }
  110. if (!method_exists($element, 'getLabel')) {
  111. return $content;
  112. }
  113. $label = $element->getLabel() . ':';
  114. if (null === ($view = $element->getView())) {
  115. return $this->renderLabel($content, $label);
  116. }
  117. $label = $view->formLabel($element->getName(), $label);
  118. return $this->renderLabel($content, $label);
  119. }
  120. public function renderLabel($content, $label)
  121. {
  122. $placement = $this->getPlacement();
  123. $separator = $this->getSeparator();
  124. switch ($placement) {
  125. case 'APPEND':
  126. return $content . $separator . $label;
  127. case 'PREPEND':
  128. default:
  129. return $label . $separator . $content;
  130. }
  131. }
  132. }
  133. ]]></programlisting>
  134. <para>
  135. Jetzt kann dem Element mitgeteilt werden diesen Plugin Pfad zu verwenden wenn
  136. nach Dekoratoren gesucht wird:
  137. </para>
  138. <programlisting role="php"><![CDATA[
  139. $element->addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator');
  140. ]]></programlisting>
  141. <para>
  142. Alternativ kann das bei der Form gemacht werden um sicherzustellen das alle
  143. Dekoratore diesen Pfad verwenden:
  144. </para>
  145. <programlisting role="php"><![CDATA[
  146. $form->addElementPrefixPath('My_Decorator', 'My/Decorator/', 'decorator');
  147. ]]></programlisting>
  148. <para>
  149. Wird dieser Pfad hinzugefügt, wenn ein Dekorator hinzugefügt wird, wird der
  150. Pfad 'My/Decorator/' zuerst durchsucht um zu sehen ob der Dekorator dort existiert.
  151. Als Ergebnis wird 'My_Decorator_Label' jetzt verwendet wenn der 'Labe' Dekorator
  152. angefragt wird.
  153. </para>
  154. </example>
  155. </sect2>
  156. <sect2 id="zend.form.elements.filters">
  157. <title>Filter</title>
  158. <para>
  159. Es ist oft nützlich und/oder notwendig einige Normalisierungen an Eingaben vorzunehmen,
  160. bevor diese geprüft werden - zum Beispiel kann es gewünscht sein alles an HTML zu
  161. entfernen, aber die Prüfungen auf dem verbleibenden durchzuführen um sicherzustellen,
  162. dass die Übertragung gültig ist. Oder man will Leerzeichen bei Eingaben entfernen, damit
  163. eine StringLength Prüfung kein falsches "Korrekt" zurückgibt. Diese Operationen können
  164. durchgeführt werden indem <classname>Zend_Filter</classname> verwendet wird, und
  165. <classname>Zend_Form_Element</classname> unterstützt Filterketten, was es erlaubt mehrere,
  166. sequentielle Filter zu spezifizieren und anzupassen. Das Filtern geschieht während
  167. der Prüfung und wenn der Wert des Elements über <code>getValue()</code> geholt wird:
  168. </para>
  169. <programlisting role="php"><![CDATA[
  170. $filtered = $element->getValue();
  171. ]]></programlisting>
  172. <para>
  173. Filter können der Kette auf zwei Wegen hinzugefügt werden:
  174. </para>
  175. <itemizedlist>
  176. <listitem><para>
  177. Übergabe einer konkreten Filterinstanz
  178. </para></listitem>
  179. <listitem><para>
  180. Angabe eines Filternamens - entweder ein Kurzname oder ein voll qualifizierter
  181. Klassenname
  182. </para></listitem>
  183. </itemizedlist>
  184. <para>
  185. Sehen wir uns einige Beispiele an:
  186. </para>
  187. <programlisting role="php"><![CDATA[
  188. // Konkrete Filterinstanz:
  189. $element->addFilter(new Zend_Filter_Alnum());
  190. // Voll qualifizierter Klassenname:
  191. $element->addFilter('Zend_Filter_Alnum');
  192. // Kurzname des Filters:
  193. $element->addFilter('Alnum');
  194. $element->addFilter('alnum');
  195. ]]></programlisting>
  196. <para>
  197. Kurznamen sind typischerweise der Filtername ohne den Präfix. Im Standardfall bedeutet
  198. das keinen 'Zend_Filter_' Präfix. Zusätzlich muss der erste Buchstabe nicht
  199. großgeschrieben werden.
  200. </para>
  201. <note>
  202. <title>Eigene Filterklassen verwenden</title>
  203. <para>
  204. Wenn man sein eigenes Set an Filterklassen hat, kann man
  205. <classname>Zend_Form_Element</classname> mitteilen diese zu verwenden indem
  206. <code>addPrefixPath()</code> verwendet wird. Wenn man zum Beispiel eigene Filter
  207. unter dem 'My_Filter' Präfix hat, kann <classname>Zend_Form_Element</classname> dies auf dem
  208. folgenden Weg mitgeteilt werden:
  209. </para>
  210. <programlisting role="php"><![CDATA[
  211. $element->addPrefixPath('My_Filter', 'My/Filter/', 'filter');
  212. ]]></programlisting>
  213. <para>
  214. (Beachten Sie, dass das dritte Agument indiziert welcher Plugin Loader auf welcher
  215. Aktion durchgeführt werden soll.)
  216. </para>
  217. </note>
  218. <para>
  219. Wenn man zu irgendeiner Zeit den ungefilterten Wert benötigt, kann die
  220. <code>getUnfilteredValue()</code> Methode verwendet werden:
  221. </para>
  222. <programlisting role="php"><![CDATA[
  223. $unfiltered = $element->getUnfilteredValue();
  224. ]]></programlisting>
  225. <para>
  226. Für weitere Informationen über Filter, siehe die
  227. <link linkend="zend.filter.introduction">Dokumentation über Zend_Filter</link>.
  228. </para>
  229. <para>
  230. Die Methoden die mit Filtern assoziiert sind, beinhalten:
  231. </para>
  232. <itemizedlist>
  233. <listitem><para>
  234. <code>addFilter($nameOfFilter, array $options = null)</code>
  235. </para></listitem>
  236. <listitem><para>
  237. <code>addFilters(array $filters)</code>
  238. </para></listitem>
  239. <listitem><para>
  240. <code>setFilters(array $filters)</code> (Überschreibt alle Filter)
  241. </para></listitem>
  242. <listitem><para>
  243. <code>getFilter($name)</code> (Empfängt ein Filterobjekt durch seinen Namen)
  244. </para></listitem>
  245. <listitem><para>
  246. <code>getFilters()</code> (Empfängt alle Filter)
  247. </para></listitem>
  248. <listitem><para>
  249. <code>removeFilter($name)</code> (Entfernt einen Filter durch seinen Namen)
  250. </para></listitem>
  251. <listitem><para>
  252. <code>clearFilters()</code> (Entfernt alle Filter)
  253. </para></listitem>
  254. </itemizedlist>
  255. </sect2>
  256. <sect2 id="zend.form.elements.validators">
  257. <title>Prüfungen</title>
  258. <para>
  259. Wenn man das Sicherheits-Mantra von "Eingabe filtern, Ausgabe escapen" unterschreibt
  260. dann wird man die Eingabe des Formulars prüfen ("Eingabefilterung") wollen. In
  261. <classname>Zend_Form</classname> enthält jedes Element seine eigene Prüfkette, die aus
  262. <classname>Zend_Validate_*</classname> Prüfungen besteht.
  263. </para>
  264. <para>
  265. Prüfungen können der Kette auf zwei Wegen hinzugefügt werden:
  266. </para>
  267. <itemizedlist>
  268. <listitem><para>
  269. Übergabe einer konkreten Prüfinstanz
  270. </para></listitem>
  271. <listitem><para>
  272. Anbieten eines Prüfnamens - entweder ein Kurzname oder ein voll qualifizierter
  273. Klassenname
  274. </para></listitem>
  275. </itemizedlist>
  276. <para>
  277. Einige Beispiele:
  278. </para>
  279. <programlisting role="php"><![CDATA[
  280. // Konkrete Prüfinstanz:
  281. $element->addValidator(new Zend_Validate_Alnum());
  282. // Voll qualifizierter Klassenname:
  283. $element->addValidator('Zend_Validate_Alnum');
  284. // Kurzer Prüfname:
  285. $element->addValidator('Alnum');
  286. $element->addValidator('alnum');
  287. ]]></programlisting>
  288. <para>
  289. Kurznamen sind typischerweise der Prüfname ohne den Präfix. Im Standardfall bedeutet
  290. das, keinen 'Zend_Validate_' Präfix. Zusätzlich muss der erste Buchstabe nicht
  291. großgeschrieben werden.
  292. </para>
  293. <note>
  294. <title>Eigene Prüfklassen verwenden</title>
  295. <para>
  296. Wenn man sein eigenes Set an Prüfklassen hat, kann man
  297. <classname>Zend_Form_Element</classname> mitteilen diese zu verwenden indem
  298. <code>addPrefixPath()</code> verwendet wird. Wenn man zum Beispiel eigene Prüfungen
  299. unter dem 'My_Validator' Präfix hat, kann <classname>Zend_Form_Element</classname> dies auf dem
  300. folgenden Weg mitgeteilt werden:
  301. </para>
  302. <programlisting role="php"><![CDATA[
  303. $element->addPrefixPath('My_Validator', 'My/Validator/', 'validate');
  304. ]]></programlisting>
  305. <para>
  306. (Beachten Sie das das dritte Agument indiziert welcher Plugin Loader auf welcher
  307. Aktion durchgeführt werden soll.)
  308. </para>
  309. </note>
  310. <para>
  311. Wenn eine bestimmte Prüfung fehlschlägt, und die Ausführung von späteren Prüfungen
  312. verhindert werden soll, kann ein <code>true</code> als zweiter Parameter übergeben
  313. werden:
  314. </para>
  315. <programlisting role="php"><![CDATA[
  316. $element->addValidator('alnum', true);
  317. ]]></programlisting>
  318. <para>
  319. Wenn ein Stringname verwendet wird, um eine Prüfung hinzuzufügen und die Prüfklasse
  320. Argumente in ihrem Konstruktor akzeptiert, können diese als dritter Parameter an
  321. <code>addValidator()</code> als Array übergeben werden:
  322. </para>
  323. <programlisting role="php"><![CDATA[
  324. $element->addValidator('StringLength', false, array(6, 20));
  325. ]]></programlisting>
  326. <para>
  327. Argumente die auf diesem Weg übergeben werden, sollten in der Reihenfolge sein in der
  328. sie im Konstruktor definiert sind. Das obige Beispiel instanziert die
  329. <classname>Zend_Validate_StringLenth</classname> Klasse mit den <code>$min</code> und
  330. <code>$max</code> Parametern:
  331. </para>
  332. <programlisting role="php"><![CDATA[
  333. $validator = new Zend_Validate_StringLength(6, 20);
  334. ]]></programlisting>
  335. <note>
  336. <title>Eigene Fehlermeldungen für Prüfungen anbieten</title>
  337. <para>
  338. Einige Entwickler wollen eigene Fehlermeldungen für eine Prüfung anbieten.
  339. <classname>Zend_Form_Element::addValidator()</classname>'s <code>$options</code> Argument
  340. erlaubt es das zu tun, indem der Schlüssel 'messages' angegeben wird und
  341. ein Array mit Schlüssel/Wert Paaren genutzt wird für das Setzen der
  342. Nachrichten Templates. Man muss die Fehlermeldungen der betreffenden Prüfung
  343. für die verschiedenen Fehlertypen von Prüfungen kennen.
  344. </para>
  345. <para>
  346. Eine bessere Option ist es <classname>Zend_Translate_Adapter</classname> in Formular zu
  347. verwenden. Fehlercodes werden automatisch dem Adapter durch den Standardmäßigen
  348. Fehlerdekorator übergeben; man kann durch die Erstellung von Übersetzungen
  349. eigene Fehlermeldungen für die verschiedenen Fehlercodes der Prüfung definieren.
  350. </para>
  351. </note>
  352. <para>
  353. Es können auch viele Prüfungen auf einmal gesetzt werden, indem
  354. <code>addValidators()</code> verwendet wird. Die grundsätzliche Verwendung ist es ein
  355. Array von Arrays zu übergeben, wobei jedes Array ein bis drei Werte enthält, die dem
  356. Konstruktor von <code>addValidator()</code> entsprechen:
  357. </para>
  358. <programlisting role="php"><![CDATA[
  359. $element->addValidators(array(
  360. array('NotEmpty', true),
  361. array('alnum'),
  362. array('stringLength', false, array(6, 20)),
  363. ));
  364. ]]></programlisting>
  365. <para>
  366. Wenn man wortreicher oder expliziter sein will, dann können die Arrayschlüssel
  367. 'validator', 'breakChainOnFailure', und 'options' verwendet werden:
  368. </para>
  369. <programlisting role="php"><![CDATA[
  370. $element->addValidators(array(
  371. array(
  372. 'validator' => 'NotEmpty',
  373. 'breakChainOnFailure' => true),
  374. array('validator' => 'alnum'),
  375. array(
  376. 'validator' => 'stringLength',
  377. 'options' => array(6, 20)),
  378. ));
  379. ]]></programlisting>
  380. <para>
  381. Die Verwendung ist gut für die Illustration wie Prüfungen in einer Konfigurationsdatei
  382. definiert werden können:
  383. </para>
  384. <programlisting role="ini"><![CDATA[
  385. element.validators.notempty.validator = "NotEmpty"
  386. element.validators.notempty.breakChainOnFailure = true
  387. element.validators.alnum.validator = "Alnum"
  388. element.validators.strlen.validator = "StringLength"
  389. element.validators.strlen.options.min = 6
  390. element.validators.strlen.options.max = 20
  391. ]]></programlisting>
  392. <para>
  393. Es ist zu beachten, dass jedes Element einen Schlüssel hat, egal ob er benötigt wird oder
  394. nicht; das ist eine Einschränkung bei der Verwendung von Konfigurationsdateien -- aber
  395. es macht auch klar, für was die Argumente stehen. Es ist einfach zu beachten das jede
  396. Prüfungsoption in der richtigen Reihenfolge spezifiziert werden muss.
  397. </para>
  398. <para>
  399. Um ein Element zu prüfen, muss der Wert an <code>isValid()</code> übergeben werden:
  400. </para>
  401. <programlisting role="php"><![CDATA[
  402. if ($element->isValid($value)) {
  403. // gülig
  404. } else {
  405. // ungültig
  406. }
  407. ]]></programlisting>
  408. <note>
  409. <title>Die Prüfung findet an gefilterten Werte statt</title>
  410. <para>
  411. <classname>Zend_Form_Element::isValid()</classname> filtert Werte durch die angegebene
  412. Filterkette vor der Überprüfung. Siehe das
  413. <link linkend="zend.form.elements.filters">Kapitel über Filter</link> für
  414. weitere Informationen.
  415. </para>
  416. </note>
  417. <note>
  418. <title>Prüfungskontext</title>
  419. <para>
  420. <classname>Zend_Form_Element::isValid()</classname> unterstützt ein zusätzliches Argument
  421. <code>$context</code>. <classname>Zend_Form::isValid()</classname> übergibt ein komplettes
  422. Array von Daten die bearbeitet werden an <code>$context</code>, wenn ein Formular
  423. geprüft wird und <classname>Zend_Form_Element::isValid()</classname> übergibt es an jede
  424. Prüfung. Das bedeutet, dass man Prüfungen schreiben kann, die auf die Daten die
  425. an andere Formulare übergeben werden acht geben. Als Beispiel nehmen wir ein
  426. Anmeldeformular, welches die Felder für Passwort und Passwort Wiederholung hat;
  427. eine Prüfung würde sein, dass beide Felder den selben Wert beinhaltenn. So eine
  428. Prüfung könnte wie folgt aussehen:
  429. </para>
  430. <programlisting role="php"><![CDATA[
  431. class My_Validate_PasswordConfirmation extends Zend_Validate_Abstract
  432. {
  433. const NOT_MATCH = 'notMatch';
  434. protected $_messageTemplates = array(
  435. self::NOT_MATCH => 'Die Passwortüberprüfung war nicht erfolgreich'
  436. );
  437. public function isValid($value, $context = null)
  438. {
  439. $value = (string) $value;
  440. $this->_setValue($value);
  441. if (is_array($context)) {
  442. if (isset($context['password_confirm'])
  443. && ($value == $context['password_confirm']))
  444. {
  445. return true;
  446. }
  447. } elseif (is_string($context) && ($value == $context)) {
  448. return true;
  449. }
  450. $this->_error(self::NOT_MATCH);
  451. return false;
  452. }
  453. }
  454. ]]></programlisting>
  455. </note>
  456. <para>
  457. Prüfungen werden in der Reihenfolge ausgeführt. Jede Prüfung wird ausgeführt solange
  458. bis eine Prüfung die mit einem <code>true</code> Wert für <code>breakChainOnFailure</code>
  459. bei Ihrer Prüfung fehlschlägt. Man sollte sichergehen, dass Prüfungen in einer begründeten
  460. Reihenfolge definiert werden.
  461. </para>
  462. <para>
  463. Nach einer fehlgeschlagenen Prüfung können Fehlercodes und Nachrichten von der
  464. Prüfkette empfangen werden:
  465. </para>
  466. <programlisting role="php"><![CDATA[
  467. $errors = $element->getErrors();
  468. $messages = $element->getMessages();
  469. ]]></programlisting>
  470. <para>
  471. (Achtung: zurückgegebene Fehlermeldungen sind ein assoziatives Array von
  472. Fehlercode/Fehlermeldung Paaren.)
  473. </para>
  474. <para>
  475. Zusätzlich zu Prüfungen, kann spezifiziert werden, dass ein Element benötigt wird, indem
  476. <code>setRequired(true)</code> verwendet wird. Standardmäßig ist dieses Flag <code>false</code>,
  477. was bedeutet, dass die Prüfkette übersprungen wird, wenn kein Wert an <code>isValid()</code>
  478. übergeben wird. Dieses Verhalten kann auf verschiedene Weisen geändert werden:
  479. </para>
  480. <itemizedlist>
  481. <listitem>
  482. <para>
  483. Standardmäßig, wenn ein Element benötigt wird, ist auch ein Flag 'allowEmpty'
  484. <code>true</code>. Das bedeutet, dass, wenn ein Wert evaluiert wird, der leer ist, und an
  485. <code>isValid()</code> übergeben wird, die Prüfung übersprungen wird. Dieses Flag kann
  486. gewechselt werden mit Hilfe der Zugriffsmethode <code>setAllowEmpty($flag)</code>; Wenn
  487. das Flag <code>false</code> ist, und ein Wert übergeben wird, werden die Prüfungen trotzdem
  488. durchlaufen.
  489. </para>
  490. </listitem>
  491. <listitem>
  492. <para>
  493. Standardmäßig, wenn ein Element benötigt wird, es aber keine 'NotEmpty'
  494. Prüfung hat, wird <code>isValid()</code> eine an oberster Stelle im Stack
  495. platzieren. Das heißt, dass das Flag folgende semantische Bedeutung bekommt:
  496. Wenn kein Wert übergeben wird, wird die Übertragung sofort ungülig und der
  497. Benutzer wird informiert, was die anderen Prüfungen davon abhält, ausgeführt
  498. zu werden, auf Daten, von denen wir bereits wissen, dass sie ungültig sind.
  499. </para>
  500. <para>
  501. Wenn dieses Verhalten nicht gewünscht ist kann es durch die Übergabe eines <code>false</code>
  502. Wert an <code>setAutoInsertNotEmptyValidator($flag)</code> ausgeschaltet werden; das
  503. verhindert, dass <code>isValid()</code> die 'NotEmpty' Prüfung in der Prüfkette platziert.
  504. </para>
  505. </listitem>
  506. </itemizedlist>
  507. <para>
  508. Für weitere Informationen über Prüfungen kann in die
  509. <link linkend="zend.validate.introduction">Zend_Validate Dokumentation</link>
  510. gesehen werden.
  511. </para>
  512. <note>
  513. <title>Verwenden von Zend_Form_Elements als generell-eingesetzte Prüfung</title>
  514. <para>
  515. <classname>Zend_Form_Element</classname> implementiert <classname>Zend_Validate_Interface</classname>
  516. was bedeutet das ein Element auch als Prüfung füreinander verwendet werden
  517. kann, bezüglich nicht-Formular Prüfketten.
  518. </para>
  519. </note>
  520. <para>
  521. Die mit der Prüfung assoziierten Methoden sind:
  522. </para>
  523. <itemizedlist>
  524. <listitem><para>
  525. <code>setRequired($flag)</code> und <code>isRequired()</code> erlauben es den
  526. Status des 'required' Flag zu setzen und zu empfangen. Wenn der Wert auf
  527. <code>true</code> gesetzt wird, erzwingt dieses Flag, dass das Element, in den
  528. Daten die von <classname>Zend_Form</classname> bearbeitet werden, vorhanden ist.
  529. </para></listitem>
  530. <listitem><para>
  531. <code>setAllowEmpty($flag)</code> und <code>getAllowEmpty()</code> erlauben es
  532. das Verhalten von optionalen Elementen (z.B. Elementen in denen das 'required'
  533. Flag <code>false</code> ist) zu ändern. Wenn das 'allowEmpty' Flag <code>true</code>
  534. ist, werden leere Werte nicht an die Prüfkette übergeben.
  535. </para></listitem>
  536. <listitem><para>
  537. <code>setAutoInsertNotEmptyValidator($flag)</code> erlaubt es zu definieren ob
  538. eine 'NotEmpty' Prüfung der Prüfkette vorangestellt wird wenn das Element
  539. benötigt wird. Standardmäßig ist dieses Flag <code>true</code>.
  540. </para></listitem>
  541. <listitem><para>
  542. <code>addValidator($nameOrValidator, $breakChainOnFailure = false, array $options = null)</code>
  543. </para></listitem>
  544. <listitem><para>
  545. <code>addValidators(array $validators)</code>
  546. </para></listitem>
  547. <listitem><para>
  548. <code>setValidators(array $validators)</code> (Überschreibt alle Prüfer)
  549. </para></listitem>
  550. <listitem><para>
  551. <code>getValidator($name)</code> (Empfängt ein Prüfobjekt durch seinen Namen)
  552. </para></listitem>
  553. <listitem><para>
  554. <code>getValidators()</code> (Empfängt alle Prüfer)
  555. </para></listitem>
  556. <listitem><para>
  557. <code>removeValidator($name)</code> (Entfernt einen Prüfer durch seinen Namen)
  558. </para></listitem>
  559. <listitem><para>
  560. <code>clearValidators()</code> (Entfernt alle Prüfer)
  561. </para></listitem>
  562. </itemizedlist>
  563. <sect3 id="zend.form.elements.validators.errors">
  564. <title>Eigene Fehlermeldungen</title>
  565. <para>
  566. Von Zeit zu Zeit ist es gewünscht ein oder mehrere spezielle Fehlermeldungen zu spezifizieren,
  567. die statt der Fehlermeldungen verwendet werden sollen, die von den Validatoren verwendet werden,
  568. die dem Element angehängt sind. Zusätzlich will man von Zeit zu Zeit ein Element selbst als
  569. ungültig markieren. Ab Version 1.6.0 des Zend Frameworks ist diese Funktionalität über die
  570. folgenden Methoden möglich.
  571. </para>
  572. <itemizedlist>
  573. <listitem><para>
  574. <code>addErrorMessage($message)</code>: Fügt eine Fehlermeldung hinzu, die bei
  575. Formular-Überprüfungs-Fehlern angezeigt wird. Sie kann mehr als einmal aufgerufen
  576. werden, und neue Meldungen werden dem Stack angehängt.
  577. </para></listitem>
  578. <listitem><para>
  579. <code>addErrorMessages(array $messages)</code>: Fügt mehrere Fehlermeldungen hinzu,
  580. die bei Formular-Überprüfungs-Fehlern angezeigt werden.
  581. </para></listitem>
  582. <listitem><para>
  583. <code>setErrorMessages(array $messages)</code>: Fügt mehrere Fehlermeldungen hinzu, die
  584. bei Formular-Überprüfungs-Fehlern angezeigt werden, und überschreibt alle vorher gesetzten
  585. Fehlermeldungen.
  586. </para></listitem>
  587. <listitem><para>
  588. <code>getErrorMessages()</code>: Empfängt eine Liste von selbstdefinierten Fehlermeldungen,
  589. die vorher definiert wurden.
  590. </para></listitem>
  591. <listitem><para>
  592. <code>clearErrorMessages()</code>: Entfernt alle eigenen Fehlermeldungen, die vorher
  593. definiert wurden.
  594. </para></listitem>
  595. <listitem><para>
  596. <code>markAsError()</code>: Markiert das Element, wie, wenn die Überprüfung fehlgeschlagen
  597. wäre.
  598. </para></listitem>
  599. <listitem><para>
  600. <code>hasErrors()</code>: Erkennt, ob ein Element eine Überprüfung nicht bestanden hat oder,
  601. ob es als ungültig markiert wurde.
  602. </para></listitem>
  603. <listitem><para>
  604. <code>addError($message)</code>: Fügt einen Fehler zum eigenen Stack der Fehlermeldungen
  605. hinzu und markiert das Element als ungültig.
  606. </para></listitem>
  607. <listitem><para>
  608. <code>addErrors(array $messages)</code>: Fügt mehrere Nachrichten zum eigenen Stack der
  609. Fehlermeldungen hinzu und markiert das Element als ungültig.
  610. </para></listitem>
  611. <listitem><para>
  612. <code>setErrors(array $messages)</code>: Überschreibt den eigenen Stack der Fehlermeldungen
  613. mit den angegebenen Meldungen und markiert das Element als ungültig.
  614. </para></listitem>
  615. </itemizedlist>
  616. <para>
  617. Alle Fehler die auf diesem Weg gesetzt werden, können übersetzt werden. Zusätzlich kann der
  618. Platzhalter "%value%" eingefügt werden um den Wert des Elements zu repräsentieren; dieser
  619. aktuelle Wert des Element wird eingefügt wenn die Fehlermeldung empfangen wird.
  620. </para>
  621. </sect3>
  622. </sect2>
  623. <sect2 id="zend.form.elements.decorators">
  624. <title>Dekoratoren</title>
  625. <para>
  626. Ein möglicher Schmerzpunkt für viele Webentwickler, ist die Erstellung von XHTML Formularen
  627. selbst. Für jedes Element muss der Entwickler das Markup für das Element selbst erstellen,
  628. typischerweise ein Label und, wenn sie nett zu den Benutzern sind, das Markup für die Anzeige
  629. von Fehlermeldungen von Prüfungen. Je mehr Elemente auf einer Seite sind, desto weniger
  630. trivial wird diese Aufgabe.
  631. </para>
  632. <para>
  633. <classname>Zend_Form_Element</classname> versucht dieses Problem durch die Verwendung von
  634. "Dekoratoren" zu lösen. Dekoratoren sind Klassen die Zugriff auf das Element
  635. haben und eine Methode zur Darstellung des Inhalts bieten. Für weitere Informationen
  636. darüber wie Dekoratoren arbeiten, kann im Kapitel über
  637. <link linkend="zend.form.decorators">Zend_Form_Decorator</link> eingesehen werden.
  638. </para>
  639. <para>
  640. Die von <classname>Zend_Form_Element</classname> verwendeten Standarddekoratoren sind:
  641. </para>
  642. <itemizedlist>
  643. <listitem><para>
  644. <emphasis>ViewHelper</emphasis>: Spezifiziert einen View Helfer der verwendet wird,
  645. um das Element darzustellen. Das 'helper' Attribut des Elements kann verwendet
  646. werden, um zu spezifizieren welcher View Helfer verwendet werden soll. Standardmäßig
  647. spezifiziert <classname>Zend_Form_Element</classname> den 'formText' View Helfer, aber
  648. individuelle Unterklassen spezifizieren unterschiedliche Helfer.
  649. </para></listitem>
  650. <listitem><para>
  651. <emphasis>Errors</emphasis>: Fügt Fehlermeldungen an das Element an, indem es
  652. <classname>Zend_View_Helper_FormErrors</classname> verwendet. Wenn keine vorhanden sind,
  653. wird nichts hinzugefügt.
  654. </para></listitem>
  655. <listitem><para>
  656. <emphasis>Description</emphasis>: Fügt dem Element eine Beschreibung hinzu. Wenn keine
  657. vorhanden ist, wird nichts angehängt. Standardmäßig wird die Beschreibung in einem
  658. &lt;p&gt; Tag dargestellt mit einer CSS Klasse namens 'description'.
  659. </para></listitem>
  660. <listitem><para>
  661. <emphasis>HtmlTag</emphasis>: Umschliesst das Element und Fehler in einem HTML &lt;dd&gt;
  662. Tag.
  663. </para></listitem>
  664. <listitem><para>
  665. <emphasis>Label</emphasis>: Stellt ein Label vor das Element, indem es
  666. <classname>Zend_View_Helper_FormLabel</classname> verwendet, und umschliesst es in einem &lt;dt&gt;
  667. Tag. Wenn kein Label angegeben wurde, wird nur das &lt;dt&gt; Tag dargestellt.
  668. </para></listitem>
  669. </itemizedlist>
  670. <note>
  671. <title>Standard Dekoratoren müssen nicht geladen werden</title>
  672. <para>
  673. Standardmäßig werden die Standarddekoratoren während der Initialisierung des Objekts
  674. geladen. Das kann durch die Übergabe der 'disableLoadDefaultDecorators' Option an
  675. den Konstruktor ausgeschaltet werden:
  676. </para>
  677. <programlisting role="php"><![CDATA[
  678. $element = new Zend_Form_Element('foo',
  679. array('disableLoadDefaultDecorators' =>
  680. true)
  681. );
  682. ]]></programlisting>
  683. <para>
  684. Diese Option kann mit jeder anderen Option gemischt werden die übergeben wird, sowohl
  685. als Array Option oder in einem <classname>Zend_Config</classname> Objekt.
  686. </para>
  687. </note>
  688. <para>
  689. Da die Reihenfolge, in der die Dekoratoren registriert werden, von Bedeutung ist -- der zuerst
  690. registrierte Dekorator wird als erstes ausgeführt -- muss man sicherstellen, dass eigene
  691. Dekoratoren in der richtigen Reihenfolge registriert werden, oder sicherstellen, dass die
  692. Platzierungs-Optionen in einem ausgewogenen Weg gesetzt werden. Um ein Beispiel zu
  693. geben, ist hier ein Code der den Standarddekorator registriert:
  694. </para>
  695. <programlisting role="php"><![CDATA[
  696. $this->addDecorators(array(
  697. array('ViewHelper'),
  698. array('Errors'),
  699. array('Description', array('tag' => 'p', 'class' => 'description')),
  700. array('HtmlTag', array('tag' => 'dd')),
  701. array('Label', array('tag' => 'dt')),
  702. ));
  703. ]]></programlisting>
  704. <para>
  705. Der anfängliche Inhalt wird vom 'ViewHelper' Dekorator erstellt, welche das Formular
  706. Element selbst erstellt. Als nächstes fängt der 'Errors' Dekorator Fehlermeldungen vom
  707. Element und, wenn welche vorhanden sind, übergibt er sie an den 'FormErrors' View Helfer
  708. zur Darstellung. Wenn eine Beschreibung vorhanden ist, wird der 'Description' Dekorator
  709. einen Paragraph der Klasse 'description' anhängen, der den beschreibenden Text für den
  710. betreffenden Inhalt enthält. Der nächste Dekorator, 'HtmlTag', umschliesst das Element
  711. und die Fehler in ein HTML &lt;dd&gt; Tag. Letztendlich, empfängt der letzte Dekorator,
  712. 'label' das Label des Elements und übergibt es an den 'FormLabel' View Helfer, und
  713. umschliesst es in einen HTML &lt;dt&gt; Tag; der Wert wird dem Inhalt standardmäßig
  714. vorangestellt. Die resultierende Ausgabe sieht grundsätzlich wie folgt aus:
  715. </para>
  716. <programlisting role="html"><![CDATA[
  717. <dt><label for="foo" class="optional">Foo</label></dt>
  718. <dd>
  719. <input type="text" name="foo" id="foo" value="123" />
  720. <ul class="errors">
  721. <li>"123" ist kein alphanummerischer Wert</li>
  722. </ul>
  723. <p class="description">
  724. Das ist etwas beschreibender Text betreffend dem Element.
  725. </p>
  726. </dd>
  727. ]]></programlisting>
  728. <para>
  729. Für weitere Informationen über Dekoratoren gibt es das
  730. <link linkend="zend.form.decorators">Kapitel über Zend_Form_Decorator</link>.
  731. </para>
  732. <note>
  733. <title>Mehrere Dekoratoren des gleichen Typs verwenden</title>
  734. <para>
  735. Intern verwendet <classname>Zend_Form_Element</classname> eine Dekoratorklasse als
  736. Mechanismus für das Nachschauen wenn Dekoratore empfangen werden. Als Ergebnis,
  737. können mehrere Dekratoren nicht zur gleichen Zeit registriert werden; nachgeordnete
  738. Dekoratoren überschreiben jene, die vorher existiert haben.
  739. </para>
  740. <para>
  741. Um das zu umgehen, können <emphasis>Aliase</emphasis> verwendet werden. Statt der
  742. Übergabe eines Dekorators oder Dekoratornamens als erstes Argument an
  743. <code>addDecorator()</code>, kann ein Array mit einem einzelnen Element übergeben
  744. werden, mit dem Alias der auf das Dekoratorobjekt oder -namen zeigt:
  745. </para>
  746. <programlisting role="php"><![CDATA[
  747. // Alias zu 'FooBar':
  748. $element->addDecorator(array('FooBar' => 'HtmlTag'),
  749. array('tag' => 'div'));
  750. // Und es später erhalten:
  751. $decorator = $element->getDecorator('FooBar');
  752. ]]></programlisting>
  753. <para>
  754. In den <code>addDecorators()</code> und <code>setDecorators()</code> Methoden
  755. muss die 'decorator' Option im Array übergeben werden, welche den Dekorator
  756. repräsentiert:
  757. </para>
  758. <programlisting role="php"><![CDATA[
  759. // Zwei 'HtmlTag' Dekoratore hinzufügen, einen Alias auf 'FooBar' setzen:
  760. $element->addDecorators(
  761. array('HtmlTag', array('tag' => 'div')),
  762. array(
  763. 'decorator' => array('FooBar' => 'HtmlTag'),
  764. 'options' => array('tag' => 'dd')
  765. ),
  766. );
  767. // Und sie später empfangen:
  768. $htmlTag = $element->getDecorator('HtmlTag');
  769. $fooBar = $element->getDecorator('FooBar');
  770. ]]></programlisting>
  771. </note>
  772. <para>
  773. Die folgenden Methoden sind mit Dekoratoren assoziiert:
  774. </para>
  775. <itemizedlist>
  776. <listitem><para>
  777. <code>addDecorator($nameOrDecorator, array $options = null)</code>
  778. </para></listitem>
  779. <listitem><para>
  780. <code>addDecorators(array $decorators)</code>
  781. </para></listitem>
  782. <listitem><para>
  783. <code>setDecorators(array $decorators)</code> (Überschreibt alle Dekoratoren)
  784. </para></listitem>
  785. <listitem><para>
  786. <code>getDecorator($name)</code> (Empfängt ein Dekoratorobjekt durch seinen Namen)
  787. </para></listitem>
  788. <listitem><para>
  789. <code>getDecorators()</code> (Empfängt alle Dekoratoren)
  790. </para></listitem>
  791. <listitem><para>
  792. <code>removeDecorator($name)</code> (Entfernt einen Dekorator durch seinen Namen)
  793. </para></listitem>
  794. <listitem><para>
  795. <code>clearDecorators()</code> (Entfernt alle Dekoratoren)
  796. </para></listitem>
  797. </itemizedlist>
  798. <para>
  799. <classname>Zend_Form_Element</classname> verwendet auch Überladung um die Darstellung von speziellen
  800. Dekoratoren zu erlauben. <code>__call()</code> interagiert mit Methoden auf mit dem Text
  801. 'render' anfangen und verwendet den Rest des Methodennamens dazu um nach einen Dekorator
  802. zu suchen; wenn er gefunden wird, wird er diesen <emphasis>einzelnen</emphasis> Dekorator
  803. darstellen. Jedes Argument das dem Methodenaufruf übergeben wird, wird als Inhalt für die
  804. Übergabe an die <code>render()</code> Methode des Dekorators verwendet. Als Beispiel:
  805. </para>
  806. <programlisting role="php"><![CDATA[
  807. // Stellt nur den ViewHelper Dekorator dar:
  808. echo $element->renderViewHelper();
  809. // Nur den HtmlTag Dekorator darstellen, und Inhalt übergeben:
  810. echo $element->renderHtmlTag("Das ist der Inhalt des HTML Tags");
  811. ]]></programlisting>
  812. <para>
  813. Wenn der Dekorator nicht existiert, wird eine Exception geworfen.
  814. </para>
  815. </sect2>
  816. <sect2 id="zend.form.elements.metadata">
  817. <title>Metadaten und Attribute</title>
  818. <para>
  819. <classname>Zend_Form_Element</classname> behandelt eine Vielzahl von Attributen und Metadaten des
  820. Elements. Basisattribute sind:
  821. </para>
  822. <itemizedlist>
  823. <listitem><para>
  824. <emphasis>name</emphasis>: Der Name des Elements. Verwendet die Zugriffsmethoden
  825. <code>setName()</code> und <code>getName()</code>.
  826. </para></listitem>
  827. <listitem><para>
  828. <emphasis>label</emphasis>: Das Label des Elements. Verwendet die Zugriffsmethoden
  829. <code>setLabel()</code> und <code>getLabel()</code>.
  830. </para></listitem>
  831. <listitem><para>
  832. <emphasis>order</emphasis>: Der Index bei dem ein Element im Formular erscheinen
  833. soll. Verwendet die Zugriffsmethoden <code>setOrder()</code> und
  834. <code>getOrder()</code>.
  835. </para></listitem>
  836. <listitem><para>
  837. <emphasis>value</emphasis>: Der aktuelle Wert des Elements. Verwendet die
  838. Zugriffsmethoden <code>setValue()</code> und <code>getValue()</code>.
  839. </para></listitem>
  840. <listitem><para>
  841. <emphasis>description</emphasis>: Eine Beschreibung des Elements; wird oft
  842. verwendet um Tooltips oder Javascript mäßige Hinweise anzubieten die den Zweck
  843. des Elements beschreiben. Verwendet die Zugriffsmethoden
  844. <code>setDescription()</code> und <code>getDescription()</code>.
  845. </para></listitem>
  846. <listitem><para>
  847. <emphasis>required</emphasis>: Ein Flag, das anzeigt ob ein Element benötigt wird
  848. wenn eine Prüfung des Formulars durchgeführt wird, oder nicht. Verwendet die
  849. Zugriffsmethoden <code>setRequired()</code> und <code>getRequired()</code>. Dieses
  850. Flag ist standardmäßig <code>false</code>.
  851. </para></listitem>
  852. <listitem><para>
  853. <emphasis>allowEmpty</emphasis>: Ein Flag, das indiziert ob ein nicht benötigtes
  854. (optionales) Element versuchen soll leere Werte zu prüfen. Wenn es <code>true</code>
  855. ist, und das 'required' Flag <code>false</code>, dann werden leere Werte nicht an
  856. die Prüfkette übergeben, und es wird <code>true</code> angenommen. Verwendet die
  857. Zugriffsmethoden <code>setAllowEmpty()</code> und <code>getAllowEmpty()</code>.
  858. Dieses Flag ist standardmäßig <code>true</code>.
  859. </para></listitem>
  860. <listitem><para>
  861. <emphasis>autoInsertNotEmptyValidator</emphasis>: Ein Flag, das indiziert, ob eine
  862. 'NotEmpty' Prüfung eingefügt werden soll, wenn das Element benötigt wird, oder
  863. nicht. Standardmäßig ist dieses Flag <code>true</code>. Das Flag kann mit
  864. <code>setAutoInsertNotEmptyValidator($flag)</code> gesetzt und der Wert mit
  865. <code>autoInsertNotEmptyValidator()</code> ermittelt werden.
  866. </para></listitem>
  867. </itemizedlist>
  868. <para>
  869. Formular Elemente können zusätzliche Metadaten benötigen. Für XHTML Form Elemente zum
  870. Beispiel, kann es gewünscht sein, Attribute wie die Klasse oder die Id zu spezifizieren.
  871. Für die Durchführung gibt es ein Set von Zugriffsmethoden:
  872. </para>
  873. <itemizedlist>
  874. <listitem><para>
  875. <emphasis>setAttrib($name, $value)</emphasis>: Fügt ein Attribut hinzu
  876. </para></listitem>
  877. <listitem><para>
  878. <emphasis>setAttribs(array $attribs)</emphasis>: Wie addAttribs(), aber
  879. überschreibend
  880. </para></listitem>
  881. <listitem><para>
  882. <emphasis>getAttrib($name)</emphasis>: Empfägt einen einzelnen Attributwert
  883. </para></listitem>
  884. <listitem><para>
  885. <emphasis>getAttribs()</emphasis>: Empfängt alle Attribute als Schlüssel/Wert Paare
  886. </para></listitem>
  887. </itemizedlist>
  888. <para>
  889. Die meiste Zeit kann auf sie, trotzdem, einfach als Objekteigenschaften zugegriffen
  890. werden, da <classname>Zend_Form_Element</classname> das Überladen realisiert und den Zugriff
  891. zu ihnen erlaubt:
  892. </para>
  893. <programlisting role="php"><![CDATA[
  894. // Gleichbedeutend mit $element->setAttrib('class', 'text'):
  895. $element->class = 'text;
  896. ]]></programlisting>
  897. <para>
  898. Standardmäßig werden alle Attribute, die an den View Helfer übergeben werden, auch vom
  899. Element während der Darstellung verwendet, und als HTML Attribute des Element Tags
  900. dargestellt.
  901. </para>
  902. </sect2>
  903. <sect2 id="zend.form.elements.standard">
  904. <title>Standard Elemente</title>
  905. <para>
  906. <classname>Zend_Form</classname> wird mit einer Anzahl an Standardelementen ausgeliefert;
  907. lesen Sie das Kapitel über
  908. <link linkend="zend.form.standardElements">Standard Elemente</link> für vollständige
  909. Details.
  910. </para>
  911. </sect2>
  912. <sect2 id="zend.form.elements.methods">
  913. <title>Zend_Form_Element Methoden</title>
  914. <para>
  915. <classname>Zend_Form_Element</classname> hat viele, viele Methoden. Was folgt, ist eine
  916. kurze Zusammenfassung ihrer Signatur - gruppiert nach Typ:
  917. </para>
  918. <itemizedlist>
  919. <listitem><para>Konfiguration:</para>
  920. <itemizedlist>
  921. <listitem><para><code>setOptions(array $options)</code></para></listitem>
  922. <listitem><para><code>setConfig(Zend_Config $config)</code></para></listitem>
  923. </itemizedlist>
  924. </listitem>
  925. <listitem><para>I18n:</para>
  926. <itemizedlist>
  927. <listitem><para><code>setTranslator(Zend_Translate_Adapter $translator = null)</code></para></listitem>
  928. <listitem><para><code>getTranslator()</code></para></listitem>
  929. <listitem><para><code>setDisableTranslator($flag)</code></para></listitem>
  930. <listitem><para><code>translatorIsDisabled()</code></para></listitem>
  931. </itemizedlist>
  932. </listitem>
  933. <listitem><para>Eigenschaften:</para>
  934. <itemizedlist>
  935. <listitem><para><code>setName($name)</code></para></listitem>
  936. <listitem><para><code>getName()</code></para></listitem>
  937. <listitem><para><code>setValue($value)</code></para></listitem>
  938. <listitem><para><code>getValue()</code></para></listitem>
  939. <listitem><para><code>getUnfilteredValue()</code></para></listitem>
  940. <listitem><para><code>setLabel($label)</code></para></listitem>
  941. <listitem><para><code>getLabel()</code></para></listitem>
  942. <listitem><para><code>setDescription($description)</code></para></listitem>
  943. <listitem><para><code>getDescription()</code></para></listitem>
  944. <listitem><para><code>setOrder($order)</code></para></listitem>
  945. <listitem><para><code>getOrder()</code></para></listitem>
  946. <listitem><para><code>setRequired($flag)</code></para></listitem>
  947. <listitem><para><code>getRequired()</code></para></listitem>
  948. <listitem><para><code>setAllowEmpty($flag)</code></para></listitem>
  949. <listitem><para><code>getAllowEmpty()</code></para></listitem>
  950. <listitem><para><code>setAutoInsertNotEmptyValidator($flag)</code></para></listitem>
  951. <listitem><para><code>autoInsertNotEmptyValidator()</code></para></listitem>
  952. <listitem><para><code>setIgnore($flag)</code></para></listitem>
  953. <listitem><para><code>getIgnore()</code></para></listitem>
  954. <listitem><para><code>getType()</code></para></listitem>
  955. <listitem><para><code>setAttrib($name, $value)</code></para></listitem>
  956. <listitem><para><code>setAttribs(array $attribs)</code></para></listitem>
  957. <listitem><para><code>getAttrib($name)</code></para></listitem>
  958. <listitem><para><code>getAttribs()</code></para></listitem>
  959. </itemizedlist>
  960. </listitem>
  961. <listitem><para>Plugin Loader und Pfade:</para>
  962. <itemizedlist>
  963. <listitem><para><code>setPluginLoader(Zend_Loader_PluginLoader_Interface $loader, $type)</code></para></listitem>
  964. <listitem><para><code>getPluginLoader($type)</code></para></listitem>
  965. <listitem><para><code>addPrefixPath($prefix, $path, $type = null)</code></para></listitem>
  966. <listitem><para><code>addPrefixPaths(array $spec)</code></para></listitem>
  967. </itemizedlist>
  968. </listitem>
  969. <listitem><para>Prüfung:</para>
  970. <itemizedlist>
  971. <listitem><para><code>addValidator($validator, $breakChainOnFailure = false, $options = array())</code></para></listitem>
  972. <listitem><para><code>addValidators(array $validators)</code></para></listitem>
  973. <listitem><para><code>setValidators(array $validators)</code></para></listitem>
  974. <listitem><para><code>getValidator($name)</code></para></listitem>
  975. <listitem><para><code>getValidators()</code></para></listitem>
  976. <listitem><para><code>removeValidator($name)</code></para></listitem>
  977. <listitem><para><code>clearValidators()</code></para></listitem>
  978. <listitem><para><code>isValid($value, $context = null)</code></para></listitem>
  979. <listitem><para><code>getErrors()</code></para></listitem>
  980. <listitem><para><code>getMessages()</code></para></listitem>
  981. </itemizedlist>
  982. </listitem>
  983. <listitem><para>Filter:</para>
  984. <itemizedlist>
  985. <listitem><para><code>addFilter($filter, $options = array())</code></para></listitem>
  986. <listitem><para><code>addFilters(array $filters)</code></para></listitem>
  987. <listitem><para><code>setFilters(array $filters)</code></para></listitem>
  988. <listitem><para><code>getFilter($name)</code></para></listitem>
  989. <listitem><para><code>getFilters()</code></para></listitem>
  990. <listitem><para><code>removeFilter($name)</code></para></listitem>
  991. <listitem><para><code>clearFilters()</code></para></listitem>
  992. </itemizedlist>
  993. </listitem>
  994. <listitem><para>Darstellung:</para>
  995. <itemizedlist>
  996. <listitem><para><code>setView(Zend_View_Interface $view = null)</code></para></listitem>
  997. <listitem><para><code>getView()</code></para></listitem>
  998. <listitem><para><code>addDecorator($decorator, $options = null)</code></para></listitem>
  999. <listitem><para><code>addDecorators(array $decorators)</code></para></listitem>
  1000. <listitem><para><code>setDecorators(array $decorators)</code></para></listitem>
  1001. <listitem><para><code>getDecorator($name)</code></para></listitem>
  1002. <listitem><para><code>getDecorators()</code></para></listitem>
  1003. <listitem><para><code>removeDecorator($name)</code></para></listitem>
  1004. <listitem><para><code>clearDecorators()</code></para></listitem>
  1005. <listitem><para><code>render(Zend_View_Interface $view = null)</code></para></listitem>
  1006. </itemizedlist>
  1007. </listitem>
  1008. </itemizedlist>
  1009. </sect2>
  1010. <sect2 id="zend.form.elements.config">
  1011. <title>Konfiguration</title>
  1012. <para>
  1013. Der Konstruktor von <classname>Zend_Form_Element</classname> akzeptiert entweder einen Array von
  1014. Optionen oder ein <classname>Zend_Config</classname> Objekt das Optionen enthält, und es kann
  1015. auch durch Verwendung von <code>setOptions()</code> oder <code>setConfig()</code>
  1016. konfiguriert werden. Generell, werden die Schlüssel wie folgt benannt:
  1017. </para>
  1018. <itemizedlist>
  1019. <listitem><para>
  1020. Wenn 'set' + Schlüssel auf eine <classname>Zend_Form_Element</classname> Methode zeigt, dann
  1021. wird der angebotene Wert zu dieser Methode übermittelt.
  1022. </para></listitem>
  1023. <listitem><para>
  1024. Andernfalls wird der Wert verwendet um ein Attribut zu setzen.
  1025. </para></listitem>
  1026. </itemizedlist>
  1027. <para>
  1028. Ausnahmen zu dieser Regel sind die folgenden:
  1029. </para>
  1030. <itemizedlist>
  1031. <listitem><para>
  1032. <code>prefixPath</code> wird an <code>addPrefixPaths()</code> übergeben
  1033. </para></listitem>
  1034. <listitem>
  1035. <para>
  1036. Die folgenden Setzer können nicht auf diesem Weg gesetzt werden:
  1037. </para>
  1038. <itemizedlist>
  1039. <listitem><para>
  1040. <code>setAttrib</code> (über <code>setAttribs</code>
  1041. <emphasis>wird</emphasis> es funktionieren)
  1042. </para></listitem>
  1043. <listitem><para><code>setConfig</code></para></listitem>
  1044. <listitem><para><code>setOptions</code></para></listitem>
  1045. <listitem><para><code>setPluginLoader</code></para></listitem>
  1046. <listitem><para><code>setTranslator</code></para></listitem>
  1047. <listitem><para><code>setView</code></para></listitem>
  1048. </itemizedlist>
  1049. </listitem>
  1050. </itemizedlist>
  1051. <para>
  1052. Als Beispiel ist hier eine Konfigurationsdatei die eine Konfiguration für jeden
  1053. Typ von konfigurierbaren Daten übergibt:
  1054. </para>
  1055. <programlisting role="ini"><![CDATA[
  1056. [element]
  1057. name = "foo"
  1058. value = "foobar"
  1059. label = "Foo:"
  1060. order = 10
  1061. required = true
  1062. allowEmpty = false
  1063. autoInsertNotEmptyValidator = true
  1064. description = "Foo Elemente sind für Beispiele"
  1065. ignore = false
  1066. attribs.id = "foo"
  1067. attribs.class = "element"
  1068. ; Setzt das 'onclick' Attribut
  1069. onclick = "autoComplete(this, '/form/autocomplete/element')"
  1070. prefixPaths.decorator.prefix = "My_Decorator"
  1071. prefixPaths.decorator.path = "My/Decorator/"
  1072. disableTranslator = 0
  1073. validators.required.validator = "NotEmpty"
  1074. validators.required.breakChainOnFailure = true
  1075. validators.alpha.validator = "alpha"
  1076. validators.regex.validator = "regex"
  1077. validators.regex.options.pattern = "/^[A-F].*/$"
  1078. filters.ucase.filter = "StringToUpper"
  1079. decorators.element.decorator = "ViewHelper"
  1080. decorators.element.options.helper = "FormText"
  1081. decorators.label.decorator = "Label"
  1082. ]]></programlisting>
  1083. </sect2>
  1084. <sect2 id="zend.form.elements.custom">
  1085. <title>Eigene Elemente</title>
  1086. <para>
  1087. Es können eigene Elemente durch die Erweiterung der <classname>Zend_Form_Element</classname>
  1088. Klasse erstellt werden. Übliche Gründe hierfür sind:
  1089. </para>
  1090. <itemizedlist>
  1091. <listitem><para>
  1092. Elemente, die eine gemeinsame Prüfung und/oder Filter teilen
  1093. </para></listitem>
  1094. <listitem><para>
  1095. Elemente die eine eigene Dekoratoren Funktionalität haben
  1096. </para></listitem>
  1097. </itemizedlist>
  1098. <para>
  1099. Es gibt zwei Methoden die typischerweise verwendet werden, um ein Element zu erweitern:
  1100. <code>init()</code>, was verwendet werden kannm um eine eigene Initialisierungs-Logik
  1101. zum Element hinzuzufügen, und <code>loadDefaultDecorators()</code>, was verwendet
  1102. werden kann um eine Liste von Standard Dekoratoren zu setzen, die vom Element
  1103. verwendet werden sollen.
  1104. </para>
  1105. <para>
  1106. Als Beispiel nehmen wir an, dass alle Text Elemente eines Formulars die erstellt werden
  1107. mit <code>StringTrim</code> gefiltert werden müssen, mit einem gemeinsamen Regulären
  1108. Ausdruck und das ein eigener Dekorator 'My_Decorator_TextItem' verwendet werden soll,
  1109. der für die Darstellung von ihnen erstellt wurde; zusätzlich gibt es eine Anzahl an
  1110. Standardattributen, wie 'size', 'maxLength', und 'class', die spezifiziert werden
  1111. sollen. So ein Element könnte wie folgt definiert werden:
  1112. </para>
  1113. <programlisting role="php"><![CDATA[
  1114. class My_Element_Text extends Zend_Form_Element
  1115. {
  1116. public function init()
  1117. {
  1118. $this->addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator')
  1119. ->addFilters('StringTrim')
  1120. ->addValidator('Regex', false, array('/^[a-z0-9]{6,}$/i'))
  1121. ->addDecorator('TextItem')
  1122. ->setAttrib('size', 30)
  1123. ->setAttrib('maxLength', 45)
  1124. ->setAttrib('class', 'text');
  1125. }
  1126. }
  1127. ]]></programlisting>
  1128. <para>
  1129. Man könnte dann das Formular Objekt über den Präfix Pfad für diese Elemente informieren,
  1130. und die Erstellung der Elemente beginnen:
  1131. </para>
  1132. <programlisting role="php"><![CDATA[
  1133. $form->addPrefixPath('My_Element', 'My/Element/', 'element')
  1134. ->addElement('text', 'foo');
  1135. ]]></programlisting>
  1136. <para>
  1137. Das 'foo' Element wird vom Typ <code>My_Element_Text</code> sein, und dem beschriebenen
  1138. Verhalten entsprechen.
  1139. </para>
  1140. <para>
  1141. Eine andere Methode, die man überschreiben sollte, wenn <classname>Zend_Form_Element</classname>
  1142. erweitert wird, ist die <code>loadDefaultDecorators()</code> Methode. Diese Methode
  1143. lädt fallweise ein Set von Standarddekoratoren für das Element; es kann gewünscht sein,
  1144. eigene Dekoratoren in der erweiterten Klasse zu verwenden:
  1145. </para>
  1146. <programlisting role="php"><![CDATA[
  1147. class My_Element_Text extends Zend_Form_Element
  1148. {
  1149. public function loadDefaultDecorators()
  1150. {
  1151. $this->addDecorator('ViewHelper')
  1152. ->addDecorator('DisplayError')
  1153. ->addDecorator('Label')
  1154. ->addDecorator('HtmlTag',
  1155. array('tag' => 'div', 'class' => 'element'));
  1156. }
  1157. }
  1158. ]]></programlisting>
  1159. <para>
  1160. Es gibt viele Wege, Elemente anzupassen; man sollte sicherstellen die API Dokumentation
  1161. von <classname>Zend_Form_Element</classname> zu lesen um alle vorhandenen Methoden zu kennen.
  1162. </para>
  1163. </sect2>
  1164. </sect1>
  1165. <!--
  1166. vim:se ts=4 sw=4 tw=80 et:
  1167. -->