Zend_Form-Forms.xml 83 KB

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