Zend_Form-Forms.xml 82 KB

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