Zend_Form-Forms.xml 73 KB

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