Zend_Form-Elements.xml 61 KB

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