2
0

Zend_Form-Elements.xml 64 KB

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