Zend_Form-Forms.xml 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15854 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.form.forms">
  5. <title>Erstellen von Form durch Verwendung von Zend_Form</title>
  6. <para>
  7. Die <classname>Zend_Form</classname> Klasse wird verwendet um Form Element, Anzeigegruppen
  8. und Unterforms zu gruppieren. Sie kann die folgenden Aktionen an diesen Elementen vornehmen:
  9. </para>
  10. <itemizedlist>
  11. <listitem><para>
  12. Prüfung, inklusive dem Empfang von Fehlercodes und Meldungen
  13. </para></listitem>
  14. <listitem><para>
  15. Werte behandeln, inklusive der Übermittlung von Elementen und dem Empfangen von beiden,
  16. gefilterten und ungefilterten Werten, von allen Elementen
  17. </para></listitem>
  18. <listitem><para>
  19. Iteration über alle Elemente in der Reihenfolge in der Sie eingegeben wurden oder
  20. basierend auf der Reihenfolge in der Hinweise von jedem Element empfangen werden
  21. </para></listitem>
  22. <listitem><para>
  23. Darstellung der kompletten Form, antweder über einen eigenen Dekorator der eigene
  24. Darstellungen durchführt oder durch die Iterierung über jedes Element in der Form
  25. </para></listitem>
  26. </itemizedlist>
  27. <para>
  28. Wärend Formen die mit <classname>Zend_Form</classname> erstellt werden komplex sein können,
  29. ist der warscheinlich beste Verwendungzweck eine einfache Form; die beste Verwendung ist für
  30. Rapid Application Development (RAD) und Prototyping.
  31. </para>
  32. <para>
  33. In der einfachsten Art, wird einfach ein Form Objekt instanziert:
  34. </para>
  35. <programlisting language="php"><![CDATA[
  36. // Generelles Form Objekt:
  37. $form = new Zend_Form();
  38. // Eigenes Form Objekt:
  39. $form = new My_Form()
  40. ]]></programlisting>
  41. <para>
  42. Es kann optional eine Instanz von <classname>Zend_Config</classname> oder ein Array
  43. übergeben werden, welches verwendet wird um den Status des Objektes zu setzen sowie
  44. potentiell neue Elemente zu erstellen:
  45. </para>
  46. <programlisting language="php"><![CDATA[
  47. // Konfigurations Optionen übergeben:
  48. $form = new Zend_Form($config);
  49. ]]></programlisting>
  50. <para>
  51. <classname>Zend_Form</classname> ist iterierbarm und iteriert durch die Elemente,
  52. Anzeigegruppen und Subforms, indem es die Reihenfolge in der diese registriert wurde
  53. verwendet und jede Reihenfolge die der Index hat. Das ist nützlich in den Fällen in denen
  54. Elemente manuell in einer bestimmten Reihenfolge dargestellt werden sollen.
  55. </para>
  56. <para>
  57. <classname>Zend_Form</classname>'s Magie liegt in der Fähigkeit als Factory für Elemente und
  58. Anzeigegruppen zu arbeiten, genauso wie die Fähigkeit sich selbst durch Dekoratore
  59. darzustellen.
  60. </para>
  61. <sect2 id="zend.form.forms.plugins">
  62. <title>Plugin Loader</title>
  63. <para>
  64. <classname>Zend_Form</classname> verwendet
  65. <classname>Zend_Loader_PluginLoader</classname> um es Entwicklern zu erlauben Orte von
  66. alternativen Elementen und Dekoratoren zu spezifizieren. Jeder hat seinen eigenen mit
  67. Ihm assoziierten Plugin Loader, und generelle Zugriffspunkte werden verwendet um jeden
  68. zu empfangen und zu ändern.
  69. </para>
  70. <para>
  71. Die folgenden Loadertypen werden mit den verschiedenen Plugin Loader Methoden
  72. verwendet: 'element' und 'decorator'. Die Typnamen sind unabhängig von der
  73. Schreibweise.
  74. </para>
  75. <para>
  76. Die Methoden um mit Plugin Loader zu interagieren sind die folgenden:
  77. </para>
  78. <itemizedlist>
  79. <listitem><para>
  80. <code>setPluginLoader($loader, $type)</code>: $loader ist das Plugin Loader Objekt
  81. selbst. Das setzt den Plugin Loader für den gegebenen Typ zu dem neu spezifizierten
  82. Loader Objekt.
  83. </para></listitem>
  84. <listitem><para>
  85. <code>getPluginLoader($type)</code>: Empfängt den mit $type assoziierten Plugin
  86. Loader.
  87. </para></listitem>
  88. <listitem><para>
  89. <code>addPrefixPath($prefix, $path, $type = null)</code>: Fügt eine Präfix/Pfad
  90. Assoziation zum durch $type spezifizierten Loader hinzu. Wenn $type null ist,
  91. versucht es den Pfad allen Loadern hinzuzufügen, durch anhängen des Präfix an jedes
  92. "_Element" und "_Decorator"; und anhängen des Pfades an "Element/" und
  93. "Decorator/". Wenn man alle Extra Form Elementklassen in einer normalen Hierarchie
  94. sind, ist das die übliche Methode für das Setzen eines Basispräfix für Sie.
  95. </para></listitem>
  96. <listitem><para>
  97. <code>addPrefixPaths(array $spec)</code>: Erlaubt es viele Pfade auf einmal zu
  98. einem oder mehreren Plugin Loadern hinzuzufügen. Sie erwartet das jedes Array
  99. Element ein Array mit den Schlüsseln 'path', 'prefix' und 'type' ist.
  100. </para></listitem>
  101. </itemizedlist>
  102. <para>
  103. Zusätzlich kann ein Präfixpfad für alle Elemente und Anzeigegruppen die durch eine
  104. <classname>Zend_Form</classname> Instanz erstellt wurden, spezifiziert werden, durch
  105. Verwendung der folgenden Methoden:
  106. </para>
  107. <itemizedlist>
  108. <listitem><para>
  109. <code>addElementPrefixPath($prefix, $path, $type = null)</code>: Wie
  110. <code>addPrefixPath()</code>, nur das ein Klassenpräfix und ein Pfad spezifiziert
  111. werden muß. Wenn <code>$type</code> spezifiziert wurde, muß er einer der Plugin
  112. Loader Typen sein die in <classname>Zend_Form_Element</classname> spezifiziert sind;
  113. siehe das <link linkend="zend.form.elements.loaders">Kapitel Element Plugins</link>
  114. für weitere Informationen über gültige <code>$type</code> Werte. Wenn kein
  115. <code>$type</code> spezifiziert wurde, nimmt diese Methode an das ein genereller
  116. Präfix für alle Typen spezifiziert wurde.
  117. </para></listitem>
  118. <listitem><para>
  119. <code>addDisplayGroupPrefixPath($prefix, $path)</code>: Wie
  120. <code>addPrefixPath()</code> nur das Klassenpräfix und ein Pfad spezifiziert werden
  121. muß; Trotzdem, da Anzeigegruppen nur Dekoratore als Plugin unterstützen, ist kein
  122. <code>$type</code> notwendig.
  123. </para></listitem>
  124. </itemizedlist>
  125. <para>
  126. Eigene Elemente und Dekoratore sind ein einfacher Weg um Funktionalitäten zwischen
  127. Forms zu teilen und eigene Funktionalitäten zu kapseln. Siehe das
  128. <link linkend="zend.form.elements.loaders.customLabel">Eigene Label Beispiel</link> in
  129. der Dokumentation über Elemente als Beispiel dafür, wie eigene Elemente als Ersatz für
  130. Standardklassen verwendet werden können.
  131. </para>
  132. </sect2>
  133. <sect2 id="zend.form.forms.elements">
  134. <title>Elemente</title>
  135. <para>
  136. <classname>Zend_Form</classname> bietet verschiedene Zugriffsmethoden für das Hinzufügen
  137. und Entfernen von Elementen aus einer Form. Diese können Instanzen von Elemente Objekten
  138. nehmen oder als Factories für das Instanzieren der Element Objekte selbe herhalten.
  139. </para>
  140. <para>
  141. Die grundsätzlichste Methode für das Hinzufügen eines Elements ist
  142. <code>addElement()</code>. Diese Methode kann entweder ein Objekt vom Typ
  143. <classname>Zend_Form_Element</classname> sein (oder einer Klasse die
  144. <classname>Zend_Form_Element</classname> erweitert), oder Argumente für das Erstellen
  145. eines neuen Elements -- inklusive dem Elementtyp, Namen, und jegliche
  146. Konfigurationsoption.
  147. </para>
  148. <para>
  149. Einige Beispiele:
  150. </para>
  151. <programlisting language="php"><![CDATA[
  152. // Eine Instanz eines Elements verwenden:
  153. $element = new Zend_Form_Element_Text('foo');
  154. $form->addElement($element);
  155. // Eine Factory verwenden
  156. //
  157. // Erstellt ein Element von Typ Zend_Form_Element_Text mit dem
  158. // Namen 'foo':
  159. $form->addElement('text', 'foo');
  160. // Eine Label Option an das Element übergeben:
  161. $form->addElement('text', 'foo', array('label' => 'Foo:'));
  162. ]]></programlisting>
  163. <note>
  164. <title>addElement() implementiert das Fluent Interface</title>
  165. <para>
  166. <code>addElement()</code> implementiert das Fluent Interface; das heißt es gibt das
  167. <classname>Zend_Form</classname> Objekt zurück und nicht das Element. Das wird getan
  168. um es zu erlauben das mehrere addElement() Methoden gekettet werden können oder
  169. andere Methoden die das Fluent Interface implementieren (alle Setzer in
  170. <classname>Zend_Form</classname> implementieren dieses Pattern).
  171. </para>
  172. <para>
  173. Wenn das Element zurückgegeben werden soll, muß stattdessen
  174. <code>createElement()</code> verwendet werden, welches anbei beschrieben wird.
  175. Trotzdem vorsicht, da <code>createElement()</code> das Element nicht der Form
  176. hinzufügt.
  177. </para>
  178. <para>
  179. <code>addElement()</code> verwendet intern <code>createElement()</code> um das
  180. Element zu erstellen bevor es der Form hinzugefügt wird.
  181. </para>
  182. </note>
  183. <para>
  184. Sobald ein Element der Form hinzugefügt wurde, kann es durch den Namen empfangen
  185. werden. Das kann entweder durch die Verwendung der <code>getElement()</code> Methode,
  186. oder durch Verwendung von Überladen um auf das Element als Objekteigenschaft
  187. zuzugreifen:
  188. </para>
  189. <programlisting language="php"><![CDATA[
  190. // getElement():
  191. $foo = $form->getElement('foo');
  192. // Als Objekteigenschaft:
  193. $foo = $form->foo;
  194. ]]></programlisting>
  195. <para>
  196. Fallweise, will man ein Element erstellen ohne es einer Form hinzuzufügen (zum
  197. Beispiel, wenn man die verschiedenen Plugin Pfade verwenden, aber das Objekt später zu
  198. einer Subform hinzufügen will). Die <code>createElement()</code> Methode erlaubt das:
  199. </para>
  200. <programlisting language="php"><![CDATA[
  201. // $username wird ein Zend_Form_Element_Text Objekt:
  202. $username = $form->createElement('text', 'username');
  203. ]]></programlisting>
  204. <sect3 id="zend.form.forms.elements.values">
  205. <title>Werte bekanntgeben und empfangen</title>
  206. <para>
  207. Nach der Prüfung einer Form, will man typischerweise die Werte empfangen damit
  208. andere Operationen durchgeführt werden können, wie das Aktualisieren einer
  209. Datenbank oder der Abfrage eines Web Services. Es können alle Werte für alle
  210. Elemente empfangen werden durch Verwendung von <code>getValues()</code>;
  211. <code>getValue($name)</code> erlabt es ausserdem den Wert eines einzelnen Elements
  212. durch den Elementnamen zu erhalten:
  213. </para>
  214. <programlisting language="php"><![CDATA[
  215. // Alle Werte erhalten:
  216. $values = $form->getValues();
  217. // Nur den Wert des 'foo' Elements erhalten:
  218. $value = $form->getValue('foo');
  219. ]]></programlisting>
  220. <para>
  221. Manchmal soll die Form mit spezifizierten Werte veröffentlicht werden bevor Sie
  222. dargestellt wird. Das kann entweder mit den <code>setDefaults()</code> oder
  223. <code>populate()</code> Methoden getan werden:
  224. </para>
  225. <programlisting language="php"><![CDATA[
  226. $form->setDefaults($data);
  227. $form->populate($data);
  228. ]]></programlisting>
  229. <para>
  230. Auf der anderen Seiten kann es gewünscht sein ein Formular, nach der Übertragung
  231. oder der Prüfung, zu löschen; das kann durch Verwendung der <code>reset()</code>
  232. Methode durchgeführt werden:
  233. </para>
  234. <programlisting language="php"><![CDATA[
  235. $form->reset();
  236. ]]></programlisting>
  237. </sect3>
  238. <sect3 id="zend.form.forms.elements.global">
  239. <title>Globale Operationen</title>
  240. <para>
  241. Fallweise wird man wollen das bestimmte Operationen alle Elemente beeinflussen.
  242. Übliche Szenarien enthalten das Setzen des Plugin Präfix Pfades für alle Elemente,
  243. Setzen der Dekoratore für alle Elemente, und das setzen von Filtern für alle
  244. Elemente. Als Beispiel:
  245. </para>
  246. <example id="zend.form.forms.elements.global.allpaths">
  247. <title>Setzen von Präfix Pfaden für alle Elemente</title>
  248. <para>
  249. Präfix Pfade können für alle Elemente durch den Typ oder der Verwendung eines
  250. globalen Präfix gesetzt werden. Einige Beispiele:
  251. </para>
  252. <programlisting language="php"><![CDATA[
  253. // Einen gobalen Präfix setzen:
  254. // Erstellt Pfade für die Präfixe My_Foo_Filter, My_Foo_Validate,
  255. // und My_Foo_Decorator
  256. $form->addElementPrefixPath('My_Foo', 'My/Foo/');
  257. // Nur Filterpfade:
  258. $form->addElementPrefixPath('My_Foo_Filter',
  259. 'My/Foo/Filter',
  260. 'filter');
  261. // Nur Prüfungspfade:
  262. $form->addElementPrefixPath('My_Foo_Validate',
  263. 'My/Foo/Validate',
  264. 'validate');
  265. // Nur Dekoratorpfade:
  266. $form->addElementPrefixPath('My_Foo_Decorator',
  267. 'My/Foo/Decorator',
  268. 'decorator');
  269. ]]></programlisting>
  270. </example>
  271. <example id="zend.form.forms.elements.global.decorators">
  272. <title>Dekoratore für alle Elemente setzen</title>
  273. <para>
  274. Man kann Dekoratore für alle Elemente setzen.
  275. <code>setElementDecorators()</code> akzeptiert ein Array von Dekoratoren, wie
  276. <code>setDecorators()</code>, und überschreibt jeden vorher gesetzten
  277. Dekorator in jedem Element. In diesem Beispiel wird der Dekorator einfach auf
  278. einen ViewHelfer und ein Label gesetzt:
  279. </para>
  280. <programlisting language="php"><![CDATA[
  281. $form->setElementDecorators(array(
  282. 'ViewHelper',
  283. 'Label'
  284. ));
  285. ]]></programlisting>
  286. </example>
  287. <example id="zend.form.forms.elements.global.decoratorsFilter">
  288. <title>Setzen von Dekoratoren für einige Elemente</title>
  289. <para>
  290. Man kann Dekoratore auch für ein Subset von Elementen setzen, entweder durch
  291. Ausbeziehung oder durch Ausgrenzung. Das zweite Argument von
  292. <code>setElementDecorators()</code> kann ein Array von Elementnamen sein;
  293. standardmäßig setzt so ein Array den spezifizierten Dekrator nur auf diese
  294. Elemente. Man kann auch einen dritten Parameter angeben, ein Flag das anzeigt ob
  295. diese Liste von Elementen einbezogen oder ausgegrenzt werden sollen. Wenn das
  296. Flag false ist, werden alle Elemente dekoriert <emphasis>ausser</emphasis> denen
  297. die in der Liste übergeben wurden. Die normale Verwendung der Methode besteht
  298. darin, das alle übergebenen Dekoratore alle vorher gesetzten Dekoratore in jedem
  299. Element überschreiben.
  300. </para>
  301. <para>
  302. Im folgenden Schnipsel, sagen wir das wir nur die ViewHelper und Label
  303. Dekoratore für die 'foo' und 'bar' Elemente haben wollen:
  304. </para>
  305. <programlisting language="php"><![CDATA[
  306. $form->setElementDecorators(
  307. array(
  308. 'ViewHelper',
  309. 'Label'
  310. ),
  311. array(
  312. 'foo',
  313. 'bar'
  314. )
  315. );
  316. ]]></programlisting>
  317. <para>
  318. Auf der anderen Seite zeigt dieses Schnipsel jetzt an das nur nur die ViewHelper
  319. und Label Dekoratore für jedes Element verwenden wollen
  320. <emphasis>ausgenommen</emphasis> die 'foo' und 'bar' Elemente:
  321. </para>
  322. <programlisting language="php"><![CDATA[
  323. $form->setElementDecorators(
  324. array(
  325. 'ViewHelper',
  326. 'Label'
  327. ),
  328. array(
  329. 'foo',
  330. 'bar'
  331. ),
  332. false
  333. );
  334. ]]></programlisting>
  335. </example>
  336. <note>
  337. <title>Einige Dekoratore sind für einige Elemente ungeeignet</title>
  338. <para>
  339. Wärend <code>setElementDecorators()</code> wie eine gute Lösung ausschaut
  340. gibt es einige Fälle in denen es zu unerwarteten Ergebnissen führen kann.
  341. Zum Beispiel verwenden die verschiedenen Button Elemente (Submit, Button,
  342. Reset) aktuell das Label als Wert des Buttons, und verwenden nur den
  343. ViewHelper und DtDdWrapper Dekorator -- was zusätzliche Labels, Fehler und
  344. Hinweise für die Darstellung verhindert. Das obige Beispiel würde einige
  345. Inhalte (das Label) für Button Elemente duplizieren.
  346. </para>
  347. <para>
  348. Man kann das Enthalten/Ausnehmen Array verwenden um dieses Problem, wie im
  349. vorherigen Beispiel gezeigt, zu umgehen.
  350. </para>
  351. <para>
  352. Diese Methode sollte also weise verwendet werden und man sollte bedenken
  353. das man einige Dekoratore von Elementen händisch ändern muss damit
  354. ungewollte Ausgaben verhindert werden.
  355. </para>
  356. </note>
  357. <example id="zend.form.forms.elements.global.filters">
  358. <title>Filter für alle Elemente setzen</title>
  359. <para>
  360. In einigen Fällen will man den selben Filter auf alle Elemente anwenden; ein
  361. üblicher Fall ist es alle Werte zu <code>trim()</code>men:
  362. </para>
  363. <programlisting language="php"><![CDATA[
  364. $form->setElementFilters(array('StringTrim'));
  365. ]]></programlisting>
  366. </example>
  367. </sect3>
  368. <sect3 id="zend.form.forms.elements.methods">
  369. <title>Methoden für die Interaktion mit Elementen</title>
  370. <para>
  371. Die folgenden Methoden können verwendet werden um mit Elementen zu interagieren:
  372. </para>
  373. <itemizedlist>
  374. <listitem><para>
  375. <code>createElement($element, $name = null, $options = null)</code>
  376. </para></listitem>
  377. <listitem><para>
  378. <code>addElement($element, $name = null, $options = null)</code>
  379. </para></listitem>
  380. <listitem><para>
  381. <code>addElements(array $elements)</code>
  382. </para></listitem>
  383. <listitem><para>
  384. <code>setElements(array $elements)</code>
  385. </para></listitem>
  386. <listitem><para>
  387. <code>getElement($name)</code>
  388. </para></listitem>
  389. <listitem><para>
  390. <code>getElements()</code>
  391. </para></listitem>
  392. <listitem><para>
  393. <code>removeElement($name)</code>
  394. </para></listitem>
  395. <listitem><para>
  396. <code>clearElements()</code>
  397. </para></listitem>
  398. <listitem><para>
  399. <code>setDefaults(array $defaults)</code>
  400. </para></listitem>
  401. <listitem><para>
  402. <code>setDefault($name, $value)</code>
  403. </para></listitem>
  404. <listitem><para>
  405. <code>getValue($name)</code>
  406. </para></listitem>
  407. <listitem><para>
  408. <code>getValues()</code>
  409. </para></listitem>
  410. <listitem><para>
  411. <code>getUnfilteredValue($name)</code>
  412. </para></listitem>
  413. <listitem><para>
  414. <code>getUnfilteredValues()</code>
  415. </para></listitem>
  416. <listitem><para>
  417. <code>setElementFilters(array $filters)</code>
  418. </para></listitem>
  419. <listitem><para>
  420. <code>setElementDecorators(array $decorators)</code>
  421. </para></listitem>
  422. <listitem><para>
  423. <code>addElementPrefixPath($prefix, $path, $type = null)</code>
  424. </para></listitem>
  425. <listitem><para>
  426. <code>addElementPrefixPaths(array $spec)</code>
  427. </para></listitem>
  428. </itemizedlist>
  429. </sect3>
  430. </sect2>
  431. <sect2 id="zend.form.forms.displaygroups">
  432. <title>Anzeigegruppen</title>
  433. <para>
  434. Anzeigegruppen sind ein Weg um virtuell Gruppierungen von Elementen für Anzeigezwecke
  435. zu erstellen. Alle Elemente bleiben durch Ihren Namen in der Form zugreifbar, aber wenn
  436. die Form iteriert oder dargestellt wird, werden alle Elemente in Anzeigegruppen
  437. gemeinsam dargestellt. Üblicherweise wird das für die Gruppierung von Elementen in
  438. Fieldsets verwendet.
  439. </para>
  440. <para>
  441. Die Basisklasse für Anzeigegruppen ist <classname>Zend_Form_DisplayGroup</classname>.
  442. Wärend Sie direkt Instanziert werden kann, ist es normalerweise am besten die
  443. <code>addDisplayGroup()</code> Methode von <classname>Zend_Form</classname> zu verwenden
  444. um das zu erledigen. Diese Methode nimmt ein Array von Elementen als erstes Argument,
  445. und einen Namen für die Anzeigegruppe als zweites Argument. Es kann optional ein Array
  446. von Optionen oder ein <classname>Zend_Config</classname> Objekt als drittes Argument
  447. übergeben werden.
  448. </para>
  449. <para>
  450. Angenommen das die Elemente 'username' und 'passwort' bereits in der Form gesetzt
  451. wurden. Dann würde der folgende Code diese Elemente in einer 'login' Anzeigegruppe
  452. gruppieren:
  453. </para>
  454. <programlisting language="php"><![CDATA[
  455. $form->addDisplayGroup(array('username', 'password'), 'login');
  456. ]]></programlisting>
  457. <para>
  458. Auf Displaygruppen kann mithilfe der <code>getDisplayGroup()</code> Methode zugegriffen
  459. werden, oder über Überladung inden der Name der Anzeigegruppe verwendet wird:
  460. </para>
  461. <programlisting language="php"><![CDATA[
  462. // getDisplayGroup() verwenden:
  463. $login = $form->getDisplayGroup('login');
  464. // Überladen verwenden:
  465. $login = $form->login;
  466. ]]></programlisting>
  467. <note>
  468. <title>Standarddekoratore müssen nicht geladen werden</title>
  469. <para>
  470. Standardmäßig werden die Standarddekoratore wärend der Initialisierung des Objektes
  471. geladen. Das kann durch die Übergabe der 'disableLoadDefaultDecorators' Option, bei
  472. der Erstellung der Anzeigegruppe, deaktiviert werden:
  473. </para>
  474. <programlisting language="php"><![CDATA[
  475. $form->addDisplayGroup(
  476. array('foo', 'bar'),
  477. 'foobar',
  478. array('disableLoadDefaultDecorators' => true)
  479. );
  480. ]]></programlisting>
  481. <para>
  482. Diese Option kann mit jeder anderen Option gemischt werden die übergeben wird,
  483. sowohl als Array Option als auch in einem <classname>Zend_Config</classname> Objekt.
  484. </para>
  485. </note>
  486. <sect3 id="zend.form.forms.displaygroups.global">
  487. <title>Globale Operationen</title>
  488. <para>
  489. Wie bei den Elementen gibt es einige Operationen welche alle Anzeigegruppen
  490. beeinflussen; diese inkludieren das Setzen von Dekoratoren und Setzen des Plugin
  491. Pfades in denen nach Dekoratoren nachgesehen werden soll.
  492. </para>
  493. <example id="zend.form.forms.displaygroups.global.paths">
  494. <title>Setzen des Dekorator Präfix Pfades für alle Anzeigegruppen</title>
  495. <para>
  496. Standardmäßig erben Anzeigegruppen die Dekorator Pfade die die Form verwendet;
  497. wenn trotzdem in alternativen Orten nachgeschaut werden soll kann die
  498. <code>addDisplayGroupPrefixPath()</code> Methode verwendet werden.
  499. </para>
  500. <programlisting language="php"><![CDATA[
  501. $form->addDisplayGroupPrefixPath('My_Foo_Decorator', 'My/Foo/Decorator');
  502. ]]></programlisting>
  503. </example>
  504. <example id="zend.form.forms.displaygroups.global.decorators">
  505. <title>Setzen von Dekoratoren für alle Anzeigegruppen</title>
  506. <para>
  507. Es können Dekoratore für alle Anzeigegruppen gesetzt werden.
  508. <code>setDisplayGroupDecorators()</code> akzeptiert ein Array von Dekoratoren,
  509. wie <code>setDecorators()</code>, und überschreibt alle vorher gesetzten
  510. Dekoratore in jeder Anzeigegruppe. In diesem Beispiel setzen wir die
  511. Dekoratore einfach auf ein Fieldset (der FormElements Dekorator ist notwendig
  512. um sicherzustellen das die Elemente iterierbar sind):
  513. </para>
  514. <programlisting language="php"><![CDATA[
  515. $form->setDisplayGroupDecorators(array(
  516. 'FormElements',
  517. 'Fieldset'
  518. ));
  519. ]]></programlisting>
  520. </example>
  521. </sect3>
  522. <sect3 id="zend.form.forms.displaygroups.customClasses">
  523. <title>Eigene Anzeigegruppen Klassen verwenden</title>
  524. <para>
  525. Standardmäßig verwendet <classname>Zend_Form</classname> die
  526. <classname>Zend_Form_DisplayGroup</classname> Klasse für Anzeigegruppen. Man kann
  527. diese Klasse erweitern um eigene Funktionalitäten anzubieten.
  528. <code>addDisplayGroup()</code> erlaubt es nicht eine konkrete Instanz zu
  529. übergeben, aber sie erlaubt es eine Klasse zu spezifizieren die als eine
  530. Ihrer Optionen verwendet wird, indem der 'displayGroupClass' Schlüssel verwendet
  531. wird:
  532. </para>
  533. <programlisting language="php"><![CDATA[
  534. // Verwenden der 'My_DisplayGroup' Klasse
  535. $form->addDisplayGroup(
  536. array('username', 'password'),
  537. 'user',
  538. array('displayGroupClass' => 'My_DisplayGroup')
  539. );
  540. ]]></programlisting>
  541. <para>
  542. Wenn die Klasse noch nicht geladen wurde, versucht <classname>Zend_Form</classname>
  543. das zu tun, indem <classname>Zend_Loader</classname> verwendet wird.
  544. </para>
  545. <para>
  546. Es kann auch eine eine Standardklasse für Anzeigegruppen definiert werden die mit
  547. der Form zu verwenden ist, sodas alle Anzeigegrupen die mit dem Form Objekt
  548. erstellt werden diese Klasse verwenden:
  549. </para>
  550. <programlisting language="php"><![CDATA[
  551. // Verwenden der Klasse 'My_DisplayGroup' für alle Anzeigegruppen:
  552. $form->setDefaultDisplayGroupClass('My_DisplayGroup');
  553. ]]></programlisting>
  554. <para>
  555. Diese Einstellung kann in Konfigurationen als 'defaultDisplayGroupClass'
  556. spezifiziert werden, und wird früh geladen um sicherzustellen das alle
  557. Anzeigegruppen diese Klasse verwenden.
  558. </para>
  559. </sect3>
  560. <sect3 id="zend.form.forms.displaygroups.interactionmethods">
  561. <title>Methoden für die Interaktion mit Anzeigegruppen</title>
  562. <para>
  563. Die folgenden Methoden können verwendet werden um mit Anzeigegruppen zu
  564. interagieren:
  565. </para>
  566. <itemizedlist>
  567. <listitem><para>
  568. <code>addDisplayGroup(array $elements, $name, $options = null)</code>
  569. </para></listitem>
  570. <listitem><para>
  571. <code>addDisplayGroups(array $groups)</code>
  572. </para></listitem>
  573. <listitem><para>
  574. <code>setDisplayGroups(array $groups)</code>
  575. </para></listitem>
  576. <listitem><para>
  577. <code>getDisplayGroup($name)</code>
  578. </para></listitem>
  579. <listitem><para>
  580. <code>getDisplayGroups()</code>
  581. </para></listitem>
  582. <listitem><para>
  583. <code>removeDisplayGroup($name)</code>
  584. </para></listitem>
  585. <listitem><para>
  586. <code>clearDisplayGroups()</code>
  587. </para></listitem>
  588. <listitem><para>
  589. <code>setDisplayGroupDecorators(array $decorators)</code>
  590. </para></listitem>
  591. <listitem><para>
  592. <code>addDisplayGroupPrefixPath($prefix, $path)</code>
  593. </para></listitem>
  594. <listitem><para>
  595. <code>setDefaultDisplayGroupClass($class)</code>
  596. </para></listitem>
  597. <listitem><para>
  598. <code>getDefaultDisplayGroupClass($class)</code>
  599. </para></listitem>
  600. </itemizedlist>
  601. </sect3>
  602. <sect3 id="zend.form.forms.displaygroups.methods">
  603. <title>Methoden von Zend_Form_DisplayGroup</title>
  604. <para>
  605. <classname>Zend_Form_DisplayGroup</classname> hat die folgenden Methoden, gruppiert
  606. nach Typ:
  607. </para>
  608. <itemizedlist>
  609. <listitem><para>Konfiguration:</para>
  610. <itemizedlist>
  611. <listitem><para><code>setOptions(array $options)</code></para></listitem>
  612. <listitem>
  613. <para><code>setConfig(Zend_Config $config)</code></para>
  614. </listitem>
  615. </itemizedlist>
  616. </listitem>
  617. <listitem><para>Metadaten:</para>
  618. <itemizedlist>
  619. <listitem><para><code>setAttrib($key, $value)</code></para></listitem>
  620. <listitem><para><code>addAttribs(array $attribs)</code></para></listitem>
  621. <listitem><para><code>setAttribs(array $attribs)</code></para></listitem>
  622. <listitem><para><code>getAttrib($key)</code></para></listitem>
  623. <listitem><para><code>getAttribs()</code></para></listitem>
  624. <listitem><para><code>removeAttrib($key)</code></para></listitem>
  625. <listitem><para><code>clearAttribs()</code></para></listitem>
  626. <listitem><para><code>setName($name)</code></para></listitem>
  627. <listitem><para><code>getName()</code></para></listitem>
  628. <listitem><para><code>setDescription($value)</code></para></listitem>
  629. <listitem><para><code>getDescription()</code></para></listitem>
  630. <listitem><para><code>setLegend($legend)</code></para></listitem>
  631. <listitem><para><code>getLegend()</code></para></listitem>
  632. <listitem><para><code>setOrder($order)</code></para></listitem>
  633. <listitem><para><code>getOrder()</code></para></listitem>
  634. </itemizedlist>
  635. </listitem>
  636. <listitem><para>Elemente:</para>
  637. <itemizedlist>
  638. <listitem>
  639. <para>
  640. <code>createElement($type, $name, array $options = array())</code>
  641. </para>
  642. </listitem>
  643. <listitem>
  644. <para>
  645. <code>addElement($typeOrElement, $name, array $options =
  646. array())</code>
  647. </para>
  648. </listitem>
  649. <listitem><para><code>addElements(array $elements)</code></para></listitem>
  650. <listitem><para><code>setElements(array $elements)</code></para></listitem>
  651. <listitem><para><code>getElement($name)</code></para></listitem>
  652. <listitem><para><code>getElements()</code></para></listitem>
  653. <listitem><para><code>removeElement($name)</code></para></listitem>
  654. <listitem><para><code>clearElements()</code></para></listitem>
  655. </itemizedlist>
  656. </listitem>
  657. <listitem><para>Plugin Loader:</para>
  658. <itemizedlist>
  659. <listitem>
  660. <para>
  661. <code>setPluginLoader(Zend_Loader_PluginLoader $loader)</code>
  662. </para>
  663. </listitem>
  664. <listitem><para><code>getPluginLoader()</code></para></listitem>
  665. <listitem><para><code>addPrefixPath($prefix, $path)</code></para></listitem>
  666. <listitem><para><code>addPrefixPaths(array $spec)</code></para></listitem>
  667. </itemizedlist>
  668. </listitem>
  669. <listitem><para>Dekoratore:</para>
  670. <itemizedlist>
  671. <listitem>
  672. <para><code>addDecorator($decorator, $options = null)</code></para>
  673. </listitem>
  674. <listitem>
  675. <para><code>addDecorators(array $decorators)</code></para>
  676. </listitem>
  677. <listitem>
  678. <para><code>setDecorators(array $decorators)</code></para>
  679. </listitem>
  680. <listitem><para><code>getDecorator($name)</code></para></listitem>
  681. <listitem><para><code>getDecorators()</code></para></listitem>
  682. <listitem><para><code>removeDecorator($name)</code></para></listitem>
  683. <listitem><para><code>clearDecorators()</code></para></listitem>
  684. </itemizedlist>
  685. </listitem>
  686. <listitem><para>Darstellung:</para>
  687. <itemizedlist>
  688. <listitem>
  689. <para><code>setView(Zend_View_Interface $view = null)</code></para>
  690. </listitem>
  691. <listitem><para><code>getView()</code></para></listitem>
  692. <listitem>
  693. <para><code>render(Zend_View_Interface $view = null)</code></para>
  694. </listitem>
  695. </itemizedlist>
  696. </listitem>
  697. <listitem><para>I18n:</para>
  698. <itemizedlist>
  699. <listitem>
  700. <para>
  701. <code>setTranslator(Zend_Translate_Adapter $translator =
  702. null)</code>
  703. </para>
  704. </listitem>
  705. <listitem><para><code>getTranslator()</code></para></listitem>
  706. <listitem><para><code>setDisableTranslator($flag)</code></para></listitem>
  707. <listitem><para><code>translatorIsDisabled()</code></para></listitem>
  708. </itemizedlist>
  709. </listitem>
  710. </itemizedlist>
  711. </sect3>
  712. </sect2>
  713. <sect2 id="zend.form.forms.subforms">
  714. <title>Subformen</title>
  715. <para>
  716. Subformen haben unterschiedliche Zwecke:
  717. </para>
  718. <itemizedlist>
  719. <listitem><para>
  720. Erstellung von logischen Element Gruppen. Da Subformen einfach Formen sind, können
  721. Sie auch wie individuelle Einheiten geprüft werden.
  722. </para></listitem>
  723. <listitem><para>
  724. Erstellung von Multi-Seiten Formen. Da Subformen einfach Formen sind, kann eine
  725. separate Subform pro Seite angezeigt werden, um Multi-Seiten Formen zu bauen in
  726. denen jede Form seine eigene Prüflogik besitzt. Nur sobald alle Subformen
  727. geprüft wurden würde die Form als komplett angenommen werden.
  728. </para></listitem>
  729. <listitem><para>
  730. Anzeige Gruppierungen. Wie Anzeigegruppen, können Subformen, wenn Sie als Teil
  731. einer größeren Form dargestellt werden, verwendet werden um Elemente zu gruppieren.
  732. Trotzdem muß darauf geachtet werden das das Hauptform Objekt keine Ahnung von den
  733. Elementen in Subformen besitzt.
  734. </para></listitem>
  735. </itemizedlist>
  736. <para>
  737. Eine Subform kann ein <classname>Zend_Form</classname> Objekt sein, oder typischerweise
  738. ein <classname>Zend_Form_SubForm</classname> Objekt. Das zweitere enthält Dekoratore die
  739. für das Einfügen in größere Formen passen (z.B. gibt es keine zusätzlichen HTML form
  740. Tags aus, gruppiert aber Elemente). Um eine Subform anzuhängen, muß diese einfach der
  741. Form hinzugefügt und ein Name vergeben werden:
  742. </para>
  743. <programlisting language="php"><![CDATA[
  744. $form->addSubForm($subForm, 'subform');
  745. ]]></programlisting>
  746. <para>
  747. Eine Subform kann empfangen werden indem entweder <code>getSubForm($name)</code> oder
  748. Überladung mithilfe des Namens der Subform verwendet wird:
  749. </para>
  750. <programlisting language="php"><![CDATA[
  751. // Verwenden von getSubForm():
  752. $subForm = $form->getSubForm('subform');
  753. // Verwenden von Überladen:
  754. $subForm = $form->subform;
  755. ]]></programlisting>
  756. <para>
  757. Subformen sind bei der Iteration der Form enthalten, aber die Elemente die Sie enthalten
  758. nicht.
  759. </para>
  760. <sect3 id="zend.form.forms.subforms.global">
  761. <title>Globale Operationen</title>
  762. <para>
  763. Wie Elemente und Anzeigegruppen. gibt es einige Operationen für die es notwendig
  764. ist alle Subformen zu bearbeiten. Anders als Anzeigegruppen und Elemente, erben
  765. Subformen die meisten Funktionalitäten vom Hauptform Objekt, und die einzige
  766. wirklich Operation die durchgeführt werden sollte, ist das Setzen der Dekoratore
  767. für Subformen. Für diesen Zweck, gibt es die <code>setSubFormDecorators()</code>
  768. Methode. Im nächsten Beispiel setzen wir den Dekorator für alle Subformen einfach
  769. auf ein Fieldset (der FormElements Dekorator wird benötigt um sicherzustellen das
  770. seine Elemente iterierbar sind):
  771. </para>
  772. <programlisting language="php"><![CDATA[
  773. $form->setSubFormDecorators(array(
  774. 'FormElements',
  775. 'Fieldset'
  776. ));
  777. ]]></programlisting>
  778. </sect3>
  779. <sect3 id="zend.form.forms.subforms.methods">
  780. <title>Methoden für die Interaktion mit Subfomen</title>
  781. <para>
  782. Die folgenden Meothden können verwendet werden um mit Subformen zu interagieren:
  783. </para>
  784. <itemizedlist>
  785. <listitem><para>
  786. <code>addSubForm(Zend_Form $form, $name, $order = null)</code>
  787. </para></listitem>
  788. <listitem><para>
  789. <code>addSubForms(array $subForms)</code>
  790. </para></listitem>
  791. <listitem><para>
  792. <code>setSubForms(array $subForms)</code>
  793. </para></listitem>
  794. <listitem><para>
  795. <code>getSubForm($name)</code>
  796. </para></listitem>
  797. <listitem><para>
  798. <code>getSubForms()</code>
  799. </para></listitem>
  800. <listitem><para>
  801. <code>removeSubForm($name)</code>
  802. </para></listitem>
  803. <listitem><para>
  804. <code>clearSubForms()</code>
  805. </para></listitem>
  806. <listitem><para>
  807. <code>setSubFormDecorators(array $decorators)</code>
  808. </para></listitem>
  809. </itemizedlist>
  810. </sect3>
  811. </sect2>
  812. <sect2 id="zend.form.forms.metadata">
  813. <title>Metadaten und Attribute</title>
  814. <para>
  815. Wärend die Nützlichkeit von Formen primär von den Elementen die Sie enthalten her
  816. rührt, enthhalten Sie auch anderen Metadaten, wie einen Namen (oft verwendet als
  817. eindeutige ID im HTML Markup); die Aktion und Methode der Form; die Anzahl an
  818. Elementen, Gruppen, und Subformen die Sie enthält; und sonstige Metadaten (die
  819. normalerweise verwendet werden um HTML Attribute für das Form Tag selbst zu setzen).
  820. </para>
  821. <para>
  822. Der Name der Form kann mithilfe der name Zugriffsmethoden gesetzt und empfangen werden:
  823. </para>
  824. <programlisting language="php"><![CDATA[
  825. // Den Namen setzen:
  826. $form->setName('registration');
  827. // Den Namen empfangen:
  828. $name = $form->getName();
  829. ]]></programlisting>
  830. <para>
  831. Um die Aktion (URL zu der die Form übermittelt) und Methode (Methode mit der
  832. übermittelt werden soll, 'POST' oder 'GET') zu setzen, können die Zugriffsmethoden für
  833. action und method verwendet werden:
  834. </para>
  835. <programlisting language="php"><![CDATA[
  836. // action und method setzen:
  837. $form->setAction('/user/login')
  838. ->setMethod('post');
  839. ]]></programlisting>
  840. <para>
  841. Man kann auch den Encoding Typ des Formulars spezifizieren indem die Enctype
  842. Zugriffsmethode verwendet wird. <classname>Zend_Form</classname> definiert zwei
  843. Konstanten, <classname>Zend_Form::ENCTYPE_URLENCODED</classname> und
  844. <classname>Zend_Form::ENCTYPE_MULTIPART</classname>, die den Werten
  845. 'application/x-www-form-urlencoded' und 'multipart/form-data' entsprechen; trotzdem kann
  846. das auf jeden gewünschten Encodingtyp gesetzt werden.
  847. </para>
  848. <programlisting language="php"><![CDATA[
  849. // Setzt die Aktion, Methoden, und Enctype:
  850. $form->setAction('/user/login')
  851. ->setMethod('post')
  852. ->setEnctype(Zend_Form::ENCTYPE_MULTIPART);
  853. ]]></programlisting>
  854. <note>
  855. <para>
  856. Methode, Aktion und Encodingtyp werden nur intern für die Darstellung verwendet,
  857. und nicht für irgendeine Art von Prüfung.
  858. </para>
  859. </note>
  860. <para>
  861. <classname>Zend_Form</classname> implementiert das <code>Countable</code> Interface,
  862. welches es erlaubt es als Argument fürs Zählen zu übergeben:
  863. </para>
  864. <programlisting language="php"><![CDATA[
  865. $numItems = count($form);
  866. ]]></programlisting>
  867. <para>
  868. Das Setzen von eigenen Metadaten wird durch die attribs Zugriffsmethode durchgeführt.
  869. Da Überladen in <classname>Zend_Form</classname> verwendet wird um auf Elemente,
  870. Anzeigegruppen, und Subformen zuzugreifen ist das die einzige Methode für den Zugriff
  871. auf Metadaten.
  872. </para>
  873. <programlisting language="php"><![CDATA[
  874. // Setzen von Attributen:
  875. $form->setAttrib('class', 'zend-form')
  876. ->addAttribs(array(
  877. 'id' => 'registration',
  878. 'onSubmit' => 'validate(this)',
  879. ));
  880. // Empfangen von Attributen:
  881. $class = $form->getAttrib('class');
  882. $attribs = $form->getAttribs();
  883. // Entfernen eines Attributes:
  884. $form->removeAttrib('onSubmit');
  885. // Löschen aller Attribute:
  886. $form->clearAttribs();
  887. ]]></programlisting>
  888. </sect2>
  889. <sect2 id="zend.form.forms.decorators">
  890. <title>Dekoratore</title>
  891. <para>
  892. Das Erstellen des Markups für eine Form ist oft ein zeitintensiver Arbeitsschritt,
  893. speziell wenn man plant das selbe Markup wiederzuverwenden um Dinge zu zeigen wie
  894. Prüffehler, übermittelte Werte, usw. <classname>Zend_Form</classname>'s Antwort hierfür
  895. sind <emphasis>Dekoratore</emphasis>.
  896. </para>
  897. <para>
  898. Dekoratore für <classname>Zend_Form</classname> Objekte können verwendet werden um eine
  899. Form darzustellen. Der FormElements Dekorator iteriert durch alle Elemente in einer form
  900. -- Elemente, Anzeigegruppen, und Subformen -- stellt sie dar, und gibt das Ergebnis
  901. zurück. Zusätzliche Dekoratore können dann verwendet werden um diese Inhalte zu
  902. wrappen, sie anzufügen oder sie voranzustellen.
  903. </para>
  904. <para>
  905. Die Standarddekoratore für <classname>Zend_Form</classname> sind FormElemente, HtmlTag
  906. (wrappt in einer Definitionsliste), und Form; der entsprechende Code für deren
  907. Erstellung ist wie folgt:
  908. </para>
  909. <programlisting language="php"><![CDATA[
  910. $form->setDecorators(array(
  911. 'FormElements',
  912. array('HtmlTag', array('tag' => 'dl')),
  913. 'Form'
  914. ));
  915. ]]></programlisting>
  916. <para>
  917. Das erstellt eine Ausgabe wie die folgende:
  918. </para>
  919. <programlisting language="html"><![CDATA[
  920. <form action="/form/action" method="post">
  921. <dl>
  922. ...
  923. </dl>
  924. </form>
  925. ]]></programlisting>
  926. <para>
  927. Jegliche Attribute die auf dem Form Objekt gesetzt sindwerden als HTML Attribute des
  928. <code>&lt;form&gt;</code> Tags verwendet.
  929. </para>
  930. <note>
  931. <title>Standarddekoratore müssen nicht geladen werden</title>
  932. <para>
  933. Standardmäßig werden die Standarddekoratore wärend der Initialisierung des Objektes
  934. geladen. Das kann durch die Übergabe der 'disableLoadDefaultDecorators' Option, bei
  935. der Erstellung der Anzeigegruppe, deaktiviert werden:
  936. </para>
  937. <programlisting language="php"><![CDATA[
  938. $form = new Zend_Form(array('disableLoadDefaultDecorators' => true));
  939. ]]></programlisting>
  940. <para>
  941. Diese Option kann mit jeder anderen Option gemischt werden die übergeben wird,
  942. sowohl als Array Option als auch in einem <classname>Zend_Config</classname> Objekt.
  943. </para>
  944. </note>
  945. <note>
  946. <title>Verwenden mehrerer Dekoratore des gleichen Typs</title>
  947. <para>
  948. Intern verwendet <classname>Zend_Form</classname> eine Dekorator Klasse als
  949. Mechsnismus für das nachsehen wenn Dekoratore empfangen werden. Als Ergebnis können
  950. mehrere Dekoratore nicht zur gleichen Zeit registriert werden; nachfolgende
  951. Dekoratore würden einfach die vorher existierenden überschreiben.
  952. </para>
  953. <para>
  954. Um das zu umgehen können Aliase verwendet werden. Statt der Übergabe eines
  955. Dekorators oder eines Dekoratornamens als erstes Argument an
  956. <code>addDecorator()</code>, kann ein Array mit einem einzelnen Argument übergeben
  957. werden, mit dem Alias der auf das Dekorator Objekt oder den Namen zeigt:
  958. </para>
  959. <programlisting language="php"><![CDATA[
  960. // Alias zu 'FooBar':
  961. $form->addDecorator(array('FooBar' => 'HtmlTag'), array('tag' => 'div'));
  962. // Und Ihn später empfangen:
  963. $form = $element->getDecorator('FooBar');
  964. ]]></programlisting>
  965. <para>
  966. In den <code>addDecorators()</code> und <code>setDecorators()</code> Methoden muß
  967. die 'decorator' Option im Array übergeben werden das den Dekorator repräsentiert:
  968. </para>
  969. <programlisting language="php"><![CDATA[
  970. // Zwei 'HtmlTag' Dekoratore hinzufügen und einen mit 'FooBar' benennen:
  971. $form->addDecorators(
  972. array('HtmlTag', array('tag' => 'div')),
  973. array(
  974. 'decorator' => array('FooBar' => 'HtmlTag'),
  975. 'options' => array('tag' => 'dd')
  976. ),
  977. );
  978. // Und Sie später empfangen:
  979. $htmlTag = $form->getDecorator('HtmlTag');
  980. $fooBar = $form->getDecorator('FooBar');
  981. ]]></programlisting>
  982. </note>
  983. <para>
  984. Man kann eigene Dekoratore für die Erzeugung der Form erstellen. Ein üblicher Grund
  985. hierfür ist, wenn man das exakte HTML weiß das man verwenden will; der Dekorator könnte
  986. das exakte HTML erstellen und es einfach zurückgeben, wobei potentiell die Dekoratore
  987. der individuellen Elemente oder Anzeigegruppen verwendet werden.
  988. </para>
  989. <para>
  990. Die folgenden Methoden können verwendet werden um mit Dekoratoren zu interagieren:
  991. </para>
  992. <itemizedlist>
  993. <listitem><para>
  994. <code>addDecorator($decorator, $options = null)</code>
  995. </para></listitem>
  996. <listitem><para>
  997. <code>addDecorators(array $decorators)</code>
  998. </para></listitem>
  999. <listitem><para>
  1000. <code>setDecorators(array $decorators)</code>
  1001. </para></listitem>
  1002. <listitem><para>
  1003. <code>getDecorator($name)</code>
  1004. </para></listitem>
  1005. <listitem><para>
  1006. <code>getDecorators()</code>
  1007. </para></listitem>
  1008. <listitem><para>
  1009. <code>removeDecorator($name)</code>
  1010. </para></listitem>
  1011. <listitem><para>
  1012. <code>clearDecorators()</code>
  1013. </para></listitem>
  1014. </itemizedlist>
  1015. <para>
  1016. <classname>Zend_Form</classname> verwendet auch das Überladen um die Darstellung von
  1017. speziellen Dekoratoren zu erlauben. <code>__call()</code> interagiert mit Methoden die
  1018. mit dem Text 'render' beginnen und verwendet den Rest des Methodennamens um nach einem
  1019. Dekorator zu suchen; wenn er gefunden wird, wird dieser <emphasis>einzelne</emphasis>
  1020. Dekorator dargestellt. Jedes Argument das dem Methodenaufruf übergeben wird, wird als
  1021. Inhalt an die <code>render()</code> Methode des Dekorators übergeben. Als Beispiel:
  1022. </para>
  1023. <programlisting language="php"><![CDATA[
  1024. // Stellt nur den FormElements Dekorator dar:
  1025. echo $form->renderFormElements();
  1026. // Stell nur den Fieldset Dekorator dar, und übergibt Inhalte:
  1027. echo $form->renderFieldset("<p>Das ist der Fieldset Inhalt</p>");
  1028. ]]></programlisting>
  1029. <para>
  1030. Wenn der Dekorator nicht existiert, wird eine Exception geworfen.
  1031. </para>
  1032. </sect2>
  1033. <sect2 id="zend.form.forms.validation">
  1034. <title>Prüfung</title>
  1035. <para>
  1036. Ein primärer Verwendungszweck für Forms ist die Überprüfung von übermittelten Daten.
  1037. <classname>Zend_Form</classname> erlaubt es eine komplette Form, eine teilweise Form,
  1038. oder Antworten von XmlHttpRequests (AJAX) zu prüfen. Wenn die übertragenen Daten nicht
  1039. gültig sind, hat es Methoden für das Empfangen der verschiedenen Fehlercodes und
  1040. Nachrichten für Elemente und Subformen.
  1041. </para>
  1042. <para>
  1043. Um eine ganze form zu prüfen, kann die <code>isValid()</code> Methode verwendet werden:
  1044. </para>
  1045. <programlisting language="php"><![CDATA[
  1046. if (!$form->isValid($_POST)) {
  1047. // Prüfung fehlgeschlagen
  1048. }
  1049. ]]></programlisting>
  1050. <para>
  1051. <code>isValid()</code> prüft jedes benötigte Element, und jedes nicht benötigte Element
  1052. das in den übermittelten Daten enthalten ist.
  1053. </para>
  1054. <para>
  1055. Manchmal muß nur ein Subset der Daten geprüft werden; dafür kann
  1056. <code>isValidPartial($data)</code> verwendet werden:
  1057. </para>
  1058. <programlisting language="php"><![CDATA[
  1059. if (!$form->isValidPartial($data)) {
  1060. // Prüfung fehlgeschlagen
  1061. }
  1062. ]]></programlisting>
  1063. <para>
  1064. <code>isValidPartial()</code> versucht nur die Teile zu prüfen für die es passende
  1065. Elemente gibt; wenn ein Element nicht in den Daten repräsentiert ist, wird es
  1066. übersprungen.
  1067. </para>
  1068. <para>
  1069. Wenn Elemente oder Gruppen von Elementen für eine AJAX Anfrage geprüft werden, wird
  1070. üblicherweise ein Subset der Form geprüft, und die Antwort in JSON zurückgegeben.
  1071. <code>processAjax()</code> führt das präzise durch:
  1072. </para>
  1073. <programlisting language="php"><![CDATA[
  1074. $json = $form->processAjax($data);
  1075. ]]></programlisting>
  1076. <para>
  1077. Man kann dann einfach die JSON Antwort an den Client senden. Wenn die Form gültig ist,
  1078. wird das eine boolsche true Antwort sein. Wenn nicht, wird es ein Javascript Objekt
  1079. sein das Schlüssel/Nachricht Paare enthält, wobei jede Nachricht 'message' ein Array
  1080. von Prüf-Fehlermeldungen enthält.
  1081. </para>
  1082. <para>
  1083. Für Forms bei denen die Prüfung fehlschlägt, können beide, Fehlercodes und
  1084. Fehlermeldung empfangen werden, indem <code>getErrors()</code> und
  1085. <code>getMessages()</code> verwendet werden:
  1086. </para>
  1087. <programlisting language="php"><![CDATA[
  1088. $codes = $form->getErrors();
  1089. $messages = $form->getMessages();
  1090. ]]></programlisting>
  1091. <note>
  1092. <para>
  1093. Da die Nachrichten die von <code>getMessages()</code> zurückgegeben werden in einem
  1094. Array von Fehlercode/Nachricht Paaren sind, wird <code>getErrors()</code>
  1095. normalerweise nicht benötigt.
  1096. </para>
  1097. </note>
  1098. <para>
  1099. Codes und Fehlermeldungen kann man für individuelle Elemente erhalten indem einfach
  1100. der Name des Elements an jede übergeben wird:
  1101. </para>
  1102. <programlisting language="php"><![CDATA[
  1103. $codes = $form->getErrors('username');
  1104. $messages = $form->getMessages('username');
  1105. ]]></programlisting>
  1106. <note>
  1107. <para>
  1108. Notiz: Wenn Elemente geprüft werden, sendet <classname>Zend_Form</classname> ein
  1109. zweites Argument zu jeder <code>isValid()</code> Methode der Elemente: Das Array der
  1110. Daten die geprüft werden sollen. Das kann von individuellen Prüfern verwendet werden
  1111. um Ihnen zu erlauben andere übertragene Werte zu verwenden wenn die Gültigkeit der
  1112. Daten ermittelt wird. Ein Beispiel wäre eine Registrations Form die beide benötigt,
  1113. ein Passwort und eine Passwort Bestätigung; das Passwort Element könnte die
  1114. Passwort Bestätigung als Teil seiner Prüfung verwenden.
  1115. </para>
  1116. </note>
  1117. <sect3 id="zend.form.forms.validation.errors">
  1118. <title>Selbst definierte Fehlermeldungen</title>
  1119. <para>
  1120. Von Zeit zu Zeit ist es gewünscht ein oder mehrere spezielle Fehlermeldungen zu
  1121. spezifizieren die statt den Fehlermeldungen verwendet werden sollen die von den
  1122. Validatoren verwendet werden die dem Element angehängt sind. Zusätzlich will man von
  1123. Zeit zu Zeit ein Element selbst als ungültig markieren. Diese Funktionalität ist
  1124. über die folgenden Methoden ermöglicht.
  1125. </para>
  1126. <itemizedlist>
  1127. <listitem><para>
  1128. <code>addErrorMessage($message)</code>: Fügt eine Fehlermeldung hinzu die bei
  1129. Form-Überprüfungs-Fehlern angezeigt wird. Sie kann mehr als einmal aufgerufen
  1130. werden, und neue Meldungen werden dem Stack angehängt.
  1131. </para></listitem>
  1132. <listitem><para>
  1133. <code>addErrorMessages(array $messages)</code>: Fügt mehrere Fehlermeldungen
  1134. hinzu die bei Form-Überprüfungs-Fehlern angezeigt werden.
  1135. </para></listitem>
  1136. <listitem><para>
  1137. <code>setErrorMessages(array $messages)</code>: Fügt mehrere Fehlermeldungen
  1138. hinzu die bei Form-Überprüfungs-Fehlern angezeigt werden, und überschreibt alle
  1139. vorher gesetzten Fehlermeldungen.
  1140. </para></listitem>
  1141. <listitem><para>
  1142. <code>getErrorMessages()</code>: Empfängt eine Liste von selbstdefinierten
  1143. Fehlermeldungen die vorher definiert wurden.
  1144. </para></listitem>
  1145. <listitem><para>
  1146. <code>clearErrorMessages()</code>: Entfernt alle eigenen Fehlermeldungen die
  1147. vorher definiert wurden.
  1148. </para></listitem>
  1149. <listitem><para>
  1150. <code>markAsError()</code>: Markiert das Element wie wenn die Überprüfung
  1151. fehlgeschlagen wäre.
  1152. </para></listitem>
  1153. <listitem><para>
  1154. <code>addError($message)</code>: Fügt einen Fehler zum eigenen Stack der
  1155. Fehlermeldungen hinzu und markiert das Element als ungültig.
  1156. </para></listitem>
  1157. <listitem><para>
  1158. <code>addErrors(array $messages)</code>: Fügt mehrere Nachrichten zum eigenen
  1159. Stack der Fehlermeldungen hinzu und markiert das Element als ungültig.
  1160. </para></listitem>
  1161. <listitem><para>
  1162. <code>setErrors(array $messages)</code>: Überschreibt den eigenen Stack der
  1163. Fehlermeldungen mit den angegebenen Meldungen und markiert das Element als
  1164. ungültig.
  1165. </para></listitem>
  1166. </itemizedlist>
  1167. <para>
  1168. Alle auf diesem Weg gesetzten Fehler können übersetzt werden.
  1169. </para>
  1170. </sect3>
  1171. </sect2>
  1172. <sect2 id="zend.form.forms.methods">
  1173. <title>Methoden</title>
  1174. <para>
  1175. Nachfolgend ist eine komplette Liste der in <classname>Zend_Form</classname> vorhandenen
  1176. Methoden, gruppiert nach Typ:
  1177. </para>
  1178. <itemizedlist>
  1179. <listitem><para>Konfiguration und Optionen:</para>
  1180. <itemizedlist>
  1181. <listitem><para><code>setOptions(array $options)</code></para></listitem>
  1182. <listitem><para><code>setConfig(Zend_Config $config)</code></para></listitem>
  1183. </itemizedlist>
  1184. </listitem>
  1185. <listitem><para>Plugin Loader und Pfade:</para>
  1186. <itemizedlist>
  1187. <listitem>
  1188. <para>
  1189. <code>setPluginLoader(Zend_Loader_PluginLoader_Interface $loader, $type
  1190. = null)</code>
  1191. </para>
  1192. </listitem>
  1193. <listitem><para><code>getPluginLoader($type = null)</code></para></listitem>
  1194. <listitem>
  1195. <para><code>addPrefixPath($prefix, $path, $type = null) </code></para>
  1196. </listitem>
  1197. <listitem><para><code>addPrefixPaths(array $spec)</code></para></listitem>
  1198. <listitem>
  1199. <para><code>addElementPrefixPath($prefix, $path, $type = null)</code></para>
  1200. </listitem>
  1201. <listitem>
  1202. <para><code>addElementPrefixPaths(array $spec)</code></para>
  1203. </listitem>
  1204. <listitem>
  1205. <para><code>addDisplayGroupPrefixPath($prefix, $path)</code></para>
  1206. </listitem>
  1207. </itemizedlist>
  1208. </listitem>
  1209. <listitem><para>Metadaten:</para>
  1210. <itemizedlist>
  1211. <listitem><para><code>setAttrib($key, $value)</code></para></listitem>
  1212. <listitem><para><code>addAttribs(array $attribs)</code></para></listitem>
  1213. <listitem><para><code>setAttribs(array $attribs)</code></para></listitem>
  1214. <listitem><para><code>getAttrib($key)</code></para></listitem>
  1215. <listitem><para><code>getAttribs()</code></para></listitem>
  1216. <listitem><para><code>removeAttrib($key)</code></para></listitem>
  1217. <listitem><para><code>clearAttribs()</code></para></listitem>
  1218. <listitem><para><code>setAction($action)</code></para></listitem>
  1219. <listitem><para><code>getAction()</code></para></listitem>
  1220. <listitem><para><code>setMethod($method)</code></para></listitem>
  1221. <listitem><para><code>getMethod()</code></para></listitem>
  1222. <listitem><para><code>setName($name)</code></para></listitem>
  1223. <listitem><para><code>getName()</code></para></listitem>
  1224. </itemizedlist>
  1225. </listitem>
  1226. <listitem><para>Elemente:</para>
  1227. <itemizedlist>
  1228. <listitem>
  1229. <para>
  1230. <code>addElement($element, $name = null, $options = null)</code>
  1231. </para>
  1232. </listitem>
  1233. <listitem><para><code>addElements(array $elements)</code></para></listitem>
  1234. <listitem><para><code>setElements(array $elements)</code></para></listitem>
  1235. <listitem><para><code>getElement($name)</code></para></listitem>
  1236. <listitem><para><code>getElements()</code></para></listitem>
  1237. <listitem><para><code>removeElement($name)</code></para></listitem>
  1238. <listitem><para><code>clearElements()</code></para></listitem>
  1239. <listitem><para><code>setDefaults(array $defaults)</code></para></listitem>
  1240. <listitem><para><code>setDefault($name, $value)</code></para></listitem>
  1241. <listitem><para><code>getValue($name)</code></para></listitem>
  1242. <listitem><para><code>getValues()</code></para></listitem>
  1243. <listitem><para><code>getUnfilteredValue($name)</code></para></listitem>
  1244. <listitem><para><code>getUnfilteredValues()</code></para></listitem>
  1245. <listitem><para><code>setElementFilters(array $filters)</code></para></listitem>
  1246. <listitem>
  1247. <para><code>setElementDecorators(array $decorators)</code></para>
  1248. </listitem>
  1249. </itemizedlist>
  1250. </listitem>
  1251. <listitem><para>Subformen:</para>
  1252. <itemizedlist>
  1253. <listitem>
  1254. <para><code>addSubForm(Zend_Form $form, $name, $order = null)</code></para>
  1255. </listitem>
  1256. <listitem><para><code>addSubForms(array $subForms)</code></para></listitem>
  1257. <listitem><para><code>setSubForms(array $subForms)</code></para></listitem>
  1258. <listitem><para><code>getSubForm($name)</code></para></listitem>
  1259. <listitem><para><code>getSubForms()</code></para></listitem>
  1260. <listitem><para><code>removeSubForm($name)</code></para></listitem>
  1261. <listitem><para><code>clearSubForms()</code></para></listitem>
  1262. <listitem>
  1263. <para><code>setSubFormDecorators(array $decorators)</code></para>
  1264. </listitem>
  1265. </itemizedlist>
  1266. </listitem>
  1267. <listitem><para>Anzeigegruppen:</para>
  1268. <itemizedlist>
  1269. <listitem>
  1270. <para>
  1271. <code>addDisplayGroup(array $elements, $name, $options = null)</code>
  1272. </para>
  1273. </listitem>
  1274. <listitem><para><code>addDisplayGroups(array $groups)</code></para></listitem>
  1275. <listitem><para><code>setDisplayGroups(array $groups)</code></para></listitem>
  1276. <listitem><para><code>getDisplayGroup($name)</code></para></listitem>
  1277. <listitem><para><code>getDisplayGroups()</code></para></listitem>
  1278. <listitem><para><code>removeDisplayGroup($name)</code></para></listitem>
  1279. <listitem><para><code>clearDisplayGroups()</code></para></listitem>
  1280. <listitem>
  1281. <para><code>setDisplayGroupDecorators(array $decorators)</code></para>
  1282. </listitem>
  1283. </itemizedlist>
  1284. </listitem>
  1285. <listitem><para>Prüfungen</para>
  1286. <itemizedlist>
  1287. <listitem><para><code>populate(array $values)</code></para></listitem>
  1288. <listitem><para><code>isValid(array $data)</code></para></listitem>
  1289. <listitem><para><code>isValidPartial(array $data)</code></para></listitem>
  1290. <listitem><para><code>processAjax(array $data)</code></para></listitem>
  1291. <listitem><para><code>persistData()</code></para></listitem>
  1292. <listitem><para><code>getErrors($name = null)</code></para></listitem>
  1293. <listitem><para><code>getMessages($name = null)</code></para></listitem>
  1294. </itemizedlist>
  1295. </listitem>
  1296. <listitem><para>Darstellung:</para>
  1297. <itemizedlist>
  1298. <listitem>
  1299. <para><code>setView(Zend_View_Interface $view = null)</code></para>
  1300. </listitem>
  1301. <listitem><para><code>getView()</code></para></listitem>
  1302. <listitem>
  1303. <para><code>addDecorator($decorator, $options = null)</code></para>
  1304. </listitem>
  1305. <listitem><para><code>addDecorators(array $decorators)</code></para></listitem>
  1306. <listitem><para><code>setDecorators(array $decorators)</code></para></listitem>
  1307. <listitem><para><code>getDecorator($name)</code></para></listitem>
  1308. <listitem><para><code>getDecorators()</code></para></listitem>
  1309. <listitem><para><code>removeDecorator($name)</code></para></listitem>
  1310. <listitem><para><code>clearDecorators()</code></para></listitem>
  1311. <listitem>
  1312. <para><code>render(Zend_View_Interface $view = null)</code></para>
  1313. </listitem>
  1314. </itemizedlist>
  1315. </listitem>
  1316. <listitem><para>I18n:</para>
  1317. <itemizedlist>
  1318. <listitem>
  1319. <para>
  1320. <code>setTranslator(Zend_Translate_Adapter $translator = null)</code>
  1321. </para>
  1322. </listitem>
  1323. <listitem><para><code>getTranslator()</code></para></listitem>
  1324. <listitem><para><code>setDisableTranslator($flag)</code></para></listitem>
  1325. <listitem><para><code>translatorIsDisabled()</code></para></listitem>
  1326. </itemizedlist>
  1327. </listitem>
  1328. </itemizedlist>
  1329. </sect2>
  1330. <sect2 id="zend.form.forms.config">
  1331. <title>Konfiguration</title>
  1332. <para>
  1333. <classname>Zend_Form</classname> ist über <code>setOptions()</code> und
  1334. <code>setConfig()</code> vollständig konfigurierbar (oder durch die Übergabe von
  1335. Optionen oder einem <classname>Zend_Config</classname> Objekt an den Konstruktor). Durch
  1336. Verwendung dieser Methoden können Form Elemente, Anzeigegruppen, Dekoratore, und
  1337. Metadaten spezifiziert werden.
  1338. </para>
  1339. <para>
  1340. Als generelle Regel, wenn 'set' + der Optionsschlüssel zu einer
  1341. <classname>Zend_Form</classname> Methode referieren, wird der angebotene Wert zu dieser
  1342. Methode übergeben. Wenn die Methode nicht existiert, wird angenommen das der Schlüssel
  1343. eine Referenz zu einem Attribut ist, und wird an <code>setAttrib()</code> übergeben.
  1344. </para>
  1345. <para>
  1346. Ausnahmen zu dieser Regel sind die folgenden:
  1347. </para>
  1348. <itemizedlist>
  1349. <listitem><para>
  1350. <code>prefixPaths</code> wird übergeben an
  1351. <code>addPrefixPaths()</code>
  1352. </para></listitem>
  1353. <listitem><para>
  1354. <code>elementPrefixPaths</code> wird übergeben an
  1355. <code>addElementPrefixPaths()</code>
  1356. </para></listitem>
  1357. <listitem><para>
  1358. <code>displayGroupPrefixPaths</code> wird übergeben an
  1359. <code>addDisplayGroupPrefixPaths()</code>
  1360. </para></listitem>
  1361. <listitem>
  1362. <para>die folgenden Setter können nicht auf diesem Weg gesetzt werden:</para>
  1363. <itemizedlist>
  1364. <listitem>
  1365. <para><code>setAttrib (da setAttribs *wird* funktionieren)</code></para>
  1366. </listitem>
  1367. <listitem><para><code>setConfig</code></para></listitem>
  1368. <listitem><para><code>setDefault</code></para></listitem>
  1369. <listitem><para><code>setOptions</code></para></listitem>
  1370. <listitem><para><code>setPluginLoader</code></para></listitem>
  1371. <listitem><para><code>setSubForms</code></para></listitem>
  1372. <listitem><para><code>setTranslator</code></para></listitem>
  1373. <listitem><para><code>setView</code></para></listitem>
  1374. </itemizedlist>
  1375. </listitem>
  1376. </itemizedlist>
  1377. <para>
  1378. Als Beispiel ist hier eine Konfigurationsdatei die eine Konfiguration für jeden Typ
  1379. von konfigurierbaren Daten übergibt:
  1380. </para>
  1381. <programlisting language="ini"><![CDATA[
  1382. [element]
  1383. name = "Registrierung"
  1384. action = "/user/register"
  1385. method = "post"
  1386. attribs.class = "zend_form"
  1387. attribs.onclick = "validate(this)"
  1388. disableTranslator = 0
  1389. prefixPath.element.prefix = "My_Element"
  1390. prefixPath.element.path = "My/Element/"
  1391. elementPrefixPath.validate.prefix = "My_Validate"
  1392. elementPrefixPath.validate.path = "My/Validate/"
  1393. displayGroupPrefixPath.prefix = "My_Group"
  1394. displayGroupPrefixPath.path = "My/Group/"
  1395. elements.username.type = "text"
  1396. elements.username.options.label = "Benutzername"
  1397. elements.username.options.validators.alpha.validator = "Alpha"
  1398. elements.username.options.filters.lcase = "StringToLower"
  1399. ; natürlich mehr Elemente...
  1400. elementFilters.trim = "StringTrim"
  1401. ;elementDecorators.trim = "StringTrim"
  1402. displayGroups.login.elements.username = "username"
  1403. displayGroups.login.elements.password = "password"
  1404. displayGroupDecorators.elements.decorator = "FormElements"
  1405. displayGroupDecorators.fieldset.decorator = "Fieldset"
  1406. decorators.elements.decorator = "FormElements"
  1407. decorators.fieldset.decorator = "FieldSet"
  1408. decorators.fieldset.decorator.options.class = "zend_form"
  1409. decorators.form.decorator = "Form"
  1410. ]]></programlisting>
  1411. <para>
  1412. Das obige könnte einfach abstrahiert werden zu einer XML oder PHP Array-basierenden
  1413. Konfigurations Datei.
  1414. </para>
  1415. </sect2>
  1416. <sect2 id="zend.form.forms.custom">
  1417. <title>Eigene Forms</title>
  1418. <para>
  1419. Eine Alternative zur Verwendung von Konfigurations-basierenden Forms ist es
  1420. <classname>Zend_Form</classname> abzuleiten. Das hat einige Vorteile:
  1421. </para>
  1422. <itemizedlist>
  1423. <listitem><para>
  1424. Die Form kein einfachst mit Unittests getestet werden um sicherzugehen das
  1425. Prüfungen und Darstellungen wie erwartet durchgeführt werden.
  1426. </para></listitem>
  1427. <listitem><para>
  1428. Eine feinkörnige Kontrolle über individuelle Elemente.
  1429. </para></listitem>
  1430. <listitem><para>
  1431. Wiederverwendung von Form Objekten, und größere Portierbarkeit (keine Notwendigkeit
  1432. Konfigurationsdateien zu verfolgen).
  1433. </para></listitem>
  1434. <listitem><para>
  1435. Eigene Funktionalitäten zu implementieren.
  1436. </para></listitem>
  1437. </itemizedlist>
  1438. <para>
  1439. Der typischste Anwendungsfall würde sein die <code>init()</code> Methode zu verwenden
  1440. um spezielle Form Elemente und Konfigurationen zu definieren:
  1441. </para>
  1442. <programlisting language="php"><![CDATA[
  1443. class My_Form_Login extends Zend_Form
  1444. {
  1445. public function init()
  1446. {
  1447. $username = new Zend_Form_Element_Text('username');
  1448. $username->class = 'formtext';
  1449. $username->setLabel('Benutzername:')
  1450. ->setDecorators(array(
  1451. array('ViewHelper',
  1452. array('helper' => 'formText')),
  1453. array('Label',
  1454. array('class' => 'label'))
  1455. ));
  1456. $password = new Zend_Form_Element_Password('password');
  1457. $password->class = 'formtext';
  1458. $password->setLabel('Benutzername:')
  1459. ->setDecorators(array(
  1460. array('ViewHelper',
  1461. array('helper' => 'formPassword')),
  1462. array('Label',
  1463. array('class' => 'label'))
  1464. ));
  1465. $submit = new Zend_Form_Element_Submit('login');
  1466. $submit->class = 'formsubmit';
  1467. $submit->setValue('Anmeldung')
  1468. ->setDecorators(array(
  1469. array('ViewHelper',
  1470. array('helper' => 'formSubmit'))
  1471. ));
  1472. $this->addElements(array(
  1473. $username,
  1474. $password,
  1475. $submit
  1476. ));
  1477. $this->setDecorators(array(
  1478. 'FormElements',
  1479. 'Fieldset',
  1480. 'Form'
  1481. ));
  1482. }
  1483. }
  1484. ]]></programlisting>
  1485. <para>
  1486. Diese form kann instanziert werden mit einem einfachen:
  1487. </para>
  1488. <programlisting language="php"><![CDATA[
  1489. $form = new My_Form_Login();
  1490. ]]></programlisting>
  1491. <para>
  1492. und die gesamte Funktionalität ist bereits eingestellt und bereit; keine
  1493. Konfigurationsdateien notwendig. (Bitte beachten das dieses Beispiel sehr vereinfacht
  1494. ist, da es keine Prüfungen oder Filter für die Elemente enthält.)
  1495. </para>
  1496. <para>
  1497. Ein anderer üblicher Grund für die Erweiterung ist es ein Set von Standard Dekoratoren
  1498. zu definieren. Das kann durch überladen der <code>loadDefaultDecorators()</code>
  1499. Methode durchgeführt werden:
  1500. </para>
  1501. <programlisting language="php"><![CDATA[
  1502. class My_Form_Login extends Zend_Form
  1503. {
  1504. public function loadDefaultDecorators()
  1505. {
  1506. $this->setDecorators(array(
  1507. 'FormElements',
  1508. 'Fieldset',
  1509. 'Form'
  1510. ));
  1511. }
  1512. }
  1513. ]]></programlisting>
  1514. </sect2>
  1515. </sect1>
  1516. <!--
  1517. vim:se ts=4 sw=4 et:
  1518. -->