Zend_Form-Forms.xml 73 KB

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