Zend_Form-StandardElements.xml 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15617 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.form.standardElements">
  5. <title>Standard Form Elemente die mit dem With Zend Framework ausgeliefert werden</title>
  6. <para>
  7. Zend Framework wird mit konkreten Element Klassen ausgeliefert die die meisten HTML
  8. Form Elemente abdecken. Die meisten spezifizieren einfach einen speziellen View Helfer
  9. zur Verwendung wenn das Element dekoriert wird, aber einige bieten zusätzliche
  10. Funktionalitäten an. Nachfolgend ist eine Liste aller solcher Klassen, sowie eine
  11. Beschreibung der Funktionalität die Sie anbieten.
  12. </para>
  13. <sect2 id="zend.form.standardElements.button">
  14. <title>Zend_Form_Element_Button</title>
  15. <para>
  16. Wird für die Erstellung von HTML Button Elementen verwendet wobei
  17. <classname>Zend_Form_Element_Button</classname>
  18. <link linkend="zend.form.standardElements.submit">Zend_Form_Element_Submit</link>
  19. erweitert, und seine eigene Funktionalität hinzufügt. Sie spezifiziert den 'formButton'
  20. View Helfer für die Dekoration.
  21. </para>
  22. <para>
  23. Wie das Submit Element, verwendet es das Label des Elements als den Elementwert für
  24. Darstellungszwecke; in anderen Worten, um den Text des Buttons zu setzen, muß der
  25. Wert des Elements gesetzt werden. Das Label wird übersetzt wenn ein
  26. Übersetzungsadapter vorhanden ist.
  27. </para>
  28. <para>
  29. Weil das Label als Teil des Elements verwendet wird, verwendet das Button Element nur
  30. den <link linkend="zend.form.standardDecorators.viewHelper">ViewHelper</link> und den
  31. <link linkend="zend.form.standardDecorators.dtDdWrapper">DtDdWrapper</link> Dekorator.
  32. </para>
  33. <para>
  34. Nach der Veröffentlichung oder Prüfung einer Form, kann geprüft werden ob der gegebene
  35. Button geklickt wurd indem die <code>isChecked()</code> Methode verwendet wird.
  36. </para>
  37. </sect2>
  38. <sect2 id="zend.form.standardElements.captcha">
  39. <title>Zend_Form_Element_Captcha</title>
  40. <para>
  41. CAPTCHAs werden verwendet um automatische Übermittlung von Formularen durch Bots und
  42. andere automatische Prozesse zu verhindern.
  43. </para>
  44. <para>
  45. Das Captcha Formularelement erlaubt es den <link
  46. linkend="zend.captcha.adapters">Zend_Captcha Adapter</link> der als Formular CAPTCHA
  47. verwendet werden soll anzupassen. Er setzt dann diesen Adapter als Prüfung für das
  48. Objekt, und verwendet den Captcha Dekorator für die Darstellung (welche den CAPTCHA
  49. Adapter aufruft).
  50. </para>
  51. <para>
  52. Adapter können alle Adapter in <classname>Zend_Captcha</classname> sein, sowie jeder
  53. eigene Adapter der irgendwo anders definiert wurde. Um das z uerlauben, kann ein
  54. zusätzlicher Schlüssel für den Plugin Ladetyp, 'CAPTCHA' oder 'captcha' übergeben
  55. werden, wenn der Plugin Loader Präfixpfad spezifiziert wird:
  56. </para>
  57. <programlisting language="php"><![CDATA[
  58. $element->addPrefixPath('My_Captcha', 'My/Captcha/', 'captcha');
  59. ]]></programlisting>
  60. <para>
  61. Captcha's können dann durch Verwendung der <code>setCaptcha()</code> Methode registriert
  62. werden, welche entweder eine konkrete CAPTCHA Instanz, oder den Kurznamen des CAPTCHA
  63. Adapters nimmt:
  64. </para>
  65. <programlisting language="php"><![CDATA[
  66. // Konkrete Instanz:
  67. $element->setCaptcha(new Zend_Captcha_Figlet());
  68. // Verwendung von Kurznamen:
  69. $element->setCaptcha('Dumb');
  70. ]]></programlisting>
  71. <para>
  72. Wenn das Element über die Konfiguration geladen werden soll, kann entweder der Schlüssel
  73. 'captcha' mit einem Array das den Schlüssel 'captcha' enthält spezifiziert werden, oder
  74. beide Schlüssel 'captcha' und 'captchaOptions':
  75. </para>
  76. <programlisting language="php"><![CDATA[
  77. // Verwendung eines einzelnen captcha Schlüssels:
  78. $element = new Zend_Form_Element_Captcha('foo', array(
  79. 'label' => "Bitte verifizieren Sie das Sie menschlich sind",
  80. 'captcha' => array(
  81. 'captcha' => 'Figlet',
  82. 'wordLen' => 6,
  83. 'timeout' => 300,
  84. ),
  85. ));
  86. // Verwendung von beiden, captcha und captchaOptions:
  87. $element = new Zend_Form_Element_Captcha('foo', array(
  88. 'label' => "Bitte verifizieren Sie das Sie menschlich sind",
  89. 'captcha' => 'Figlet',
  90. 'captchaOptions' => array(
  91. 'captcha' => 'Figlet',
  92. 'wordLen' => 6,
  93. 'timeout' => 300,
  94. ),
  95. ));
  96. ]]></programlisting>
  97. <para>
  98. Der verwendete Dekorator wird durch die Abfrage des Captcha Adapters erkannt.
  99. Standardmäßig wird der <link linkend="zend.form.standardDecorators.captcha">Captcha
  100. Dekorator</link> verwendet, aber ein Adapter kann einen anderen über die
  101. <code>getDecorator()</code> Methode spezifizieren.
  102. </para>
  103. <para>
  104. Wie beschrieben, fungiert der Captcha Adapter selbst als Prüfnug für das Element.
  105. Zusätzlich wird die NotEmpty Prüfung nicht verwendet, und das Element wird als benötigt
  106. markiert. In den meisten Fällen sollte sonst nichts anderes mehr notwendig sein um das
  107. Captcha im eigenen Formular zu haben.
  108. </para>
  109. </sect2>
  110. <sect2 id="zend.form.standardElements.checkbox">
  111. <title>Zend_Form_Element_Checkbox</title>
  112. <para>
  113. HTML Checkboxen erlauben es spezifische Werte zurückzugeben, arbeiten aber
  114. grundsätzlich als Boolean. Wenn Sie angehackt sind, wird der Wert der Checkbox
  115. übertragen. Wenn Sie nicht angehackt sind, wird nichts übertragen. Intern erzwingt
  116. <classname>Zend_Form_Element_Checkbox</classname> diesen Status.
  117. </para>
  118. <para>
  119. Standardmäßg ist der angehackte Wert '1', und der nicht angehackte Wert '0'. Dieser
  120. Wert kann spezifiziert werden indem die <code>setCheckedValue()</code> und
  121. <code>setUncheckedValue()</code> Zugriffsmethoden verwendet werden. Intern wird,
  122. jedesmal wenn der Wert gesetzt wird, wenn der angebotene Wert dem angehackten Wert
  123. entspricht, er gesetzt, aber jeder andere Wert bewirkt das der nicht angehackte Wert
  124. gesetzt wird.
  125. </para>
  126. <para>
  127. Zusätzlich setzt, das Setzen des Werte, die <code>checked</code> Eigenschaft der
  128. Checkbox. Das kann abgefragt werden indem <code>isChecked()</code> verwendet wird oder
  129. einfach auf die Eigenschaft zugegriffen wird. Das Verwenden der
  130. <code>setChecked($flag)</code> Methode setzt beides, den Status des Flags sowie den
  131. entsprechenden gecheckten oder nicht gecheckten Wert im Element. Bitte verwenden Sie
  132. diese Methode wenn der gecheckte Status eines Checkbox Elements gesetzt wird um
  133. sicherzustellen das der Wert richtig gesetzt wird.
  134. </para>
  135. <para>
  136. <classname>Zend_Form_Element_Checkbox</classname> verwendet den 'formCheckbox' View
  137. Helfer. Der angehackte Wert wird immer verwendet um Sie zu veröffentlichen.
  138. </para>
  139. </sect2>
  140. <sect2 id="zend.form.standardElements.file">
  141. <title>Zend_Form_Element_File</title>
  142. <para>
  143. Das File Formularelement bietet einen Mechanismus um File Upload-felder in eigenen
  144. Formularen zu Unterstützen. Es verwendet intern
  145. <link linkend="zend.file.transfer.introduction">Zend_File_Transfer</link> um diese
  146. Funktionalität zu bieten, und den <code>FormFile</code> Viewhelfer sowie den
  147. <code>File</code> Decorator um das Formularelement anzuzeigen.
  148. </para>
  149. <para>
  150. Standardmäßig verwendet es den <code>Http</code> Transferadapter, welcher das
  151. <code>$_FILES</code> Array prüft und es erlaubt Prüfungen und Filter hinzuzufügen.
  152. Prüfungen und Filter die dem Formularelement hinzugefügt werden, werden dem
  153. Transferadapter hinzugefügt.
  154. </para>
  155. <example id="zend.form.standardElements.file.usage">
  156. <title>Verwendung des File Formularelements</title>
  157. <para>
  158. Die obige Erklärung der Verwendung des File Formularelements mag geheimnisvoll
  159. erscheinen, aber die aktuelle Verwendung ist relativ trivial:
  160. </para>
  161. <programlisting language="php"><![CDATA[
  162. $element = new Zend_Form_Element_File('foo');
  163. $element->setLabel('Ein Bild hochladen:')
  164. ->setDestination('/var/www/upload');
  165. // Nur 1 Datei sicherstellen
  166. $element->addValidator('Count', false, 1);
  167. // Maximal 100k
  168. $element->addValidator('Size', false, 102400);
  169. // Nur JPEG, PNG, und GIFs
  170. $element->addValidator('Extension', false, 'jpg,png,gif');
  171. $form->addElement($element, 'foo');
  172. ]]></programlisting>
  173. <para>
  174. Man sollte auch den richtigen Encodingtyp sicherstellen in dem das Formular
  175. angeboten wird. Das kann getan werden indem das 'enctype' Attribut des Formulars
  176. gesetzt wird:
  177. </para>
  178. <programlisting language="php"><![CDATA[
  179. $form->setAttrib('enctype', 'multipart/form-data');
  180. ]]></programlisting>
  181. <para>
  182. Nachdem das Formular erfolgreich geprüft wurde, muß die Datei empfangen werden um
  183. Sie an Ihrem endgültigen Ziel zu speichern indem <code>receive()</code> verwendet
  184. wird. Zusätzlich kann man das endgültige Ziel ermittelt werden indem
  185. <code>getFileName()</code> verwendet wird:
  186. </para>
  187. <programlisting language="php"><![CDATA[
  188. if (!$form->isValid) {
  189. print "Uh oh... Prüfungsfehler";
  190. }
  191. if (!$form->foo->receive()) {
  192. print "Fehler beim Empfangen der Datei";
  193. }
  194. $location = $form->foo->getFileName();
  195. ]]></programlisting>
  196. </example>
  197. <note>
  198. <title>Standardmäßige Ablage von Uploads</title>
  199. <para>
  200. Standardmäßig werden Dateien in das Temp Verzeichnis des Systems hochgeladen.
  201. </para>
  202. </note>
  203. <note>
  204. <title>Datei Werte</title>
  205. <para>
  206. In HTTP hat das File Element keinen Wert. Aus diesem Grund, und aus Gründen der
  207. Sicherheit erhält gibt <code>getValue()</code> nur den Dateinamen der hochgeladenen
  208. Datei zurück und nicht den kompletten Pfad. Wenn man die kompletten Informationen
  209. benötigt kann <code>getFileName()</code> aufgerufen werden, welches sowohl den Pfad
  210. als auch den Namen der Datei zurückgibt.
  211. </para>
  212. </note>
  213. <para>
  214. Standardmäßig wird die Datei automatisch empfangen wenn man <code>getValues()</code>
  215. auf dem Formular aufruft. Der Grund hinter diesem Verhalten ist, das die Datei selbst
  216. der Wert des File Elements ist.
  217. </para>
  218. <programlisting language="php"><![CDATA[
  219. $form->getValues();
  220. ]]></programlisting>
  221. <note>
  222. <para>
  223. Deshalb hat ein weiterer Aufruf von <code>receive()</code> nach dem Aufruf von
  224. <code>getValues()</code> keinen Effekt. Auch die Erstellung einer Instanz von
  225. <classname>Zend_File_Transfer</classname> wird keinen Effekt haben da es keine
  226. weitere Datei zum Empfangen gibt.
  227. </para>
  228. </note>
  229. <para>
  230. Trotzdem kann es manchmal gewünscht sein <code>getValues()</code> aufzurufen ohne das
  231. die Datei empfangen wird. Man kann dies erreichen indem
  232. <code>setValueDisabled(true)</code> aufgerufen wird. Um den aktuellen Wert dieses
  233. Flags zu erhalten kann man <code>isValueDisabled()</code> aufrufen.
  234. </para>
  235. <example id="zend.form.standardElements.file.retrievement">
  236. <title>Datei explizit empfangen</title>
  237. <para>
  238. Zuerst <code>setValueDisabled(true)</code> aufrufen.
  239. </para>
  240. <programlisting language="php"><![CDATA[
  241. $element = new Zend_Form_Element_File('foo');
  242. $element->setLabel('Ein Bild hochladen:')
  243. ->setDestination('/var/www/upload')
  244. ->setValueDisabled(true);
  245. ]]></programlisting>
  246. <para>
  247. Jetzt wird die Datei nicht mehr empfangen wenn man <code>getValues()</code>
  248. aufruft. Man muß also <code>receive()</code> vom Datei Element, oder einer
  249. Instanz von <classname>Zend_File_Transfer</classname> selbst aufrufen.
  250. </para>
  251. <programlisting language="php"><![CDATA[
  252. $values = $form->getValues();
  253. if ($form->isValid($form->getPost())) {
  254. if (!$form->foo->receive()) {
  255. print "Upload Fehler";
  256. }
  257. }
  258. ]]></programlisting>
  259. </example>
  260. <para>
  261. Es gibt verschiedene Stati von hochgeladenen Dateien welche mit den folgenden Optionen
  262. geprüft werden können:
  263. </para>
  264. <itemizedlist>
  265. <listitem>
  266. <para>
  267. <code>isUploaded()</code>: Prüft ob das Dateielement hochgeladen wurde oder
  268. nicht.
  269. </para>
  270. </listitem>
  271. <listitem>
  272. <para>
  273. <code>isReceived()</code>: Prüft ob das Dateielement bereits empfangen wurde.
  274. </para>
  275. </listitem>
  276. <listitem>
  277. <para>
  278. <code>isFiltered()</code>: Prüft ob die Filter bereits dem Dateielement
  279. angehängt wurden oder nicht.
  280. </para>
  281. </listitem>
  282. </itemizedlist>
  283. <example id="zend.form.standardElements.file.isuploaded">
  284. <title>Prüfen ob eine optionale Datei hochgeladen wurde</title>
  285. <programlisting language="php"><![CDATA[
  286. $element = new Zend_Form_Element_File('foo');
  287. $element->setLabel('Ein Bild hochladen:')
  288. ->setDestination('/var/www/upload')
  289. ->setRequired(false);
  290. $element->addValidator('Size', false, 102400);
  291. $form->addElement($element, 'foo');
  292. // Das foo Dateielement is optional, aber wenn es angegeben wurde, gehe hier herein
  293. if ($form->foo->isUploaded()) {
  294. // Die foo Datei ist angegeben... mach was
  295. }
  296. ]]></programlisting>
  297. </example>
  298. <para>
  299. <classname>Zend_Form_Element_File</classname> unterstützt auch mehrere Dateien. Durch
  300. den Aufruf der <code>setMultiFile($count)</code> Methode kann die Anzahl an File
  301. Elementen die man erstellen will festgelegt werden. Das verhindert das die selben
  302. Einstellungen mehrere Male durchgeführt werden müssen.
  303. </para>
  304. <example id="zend.form.standardElements.file.multiusage">
  305. <title>Mehrere Dateien setzen</title>
  306. <para>
  307. Die Erstellung eines Multifile Elements ist das gleiche wie das Erstellen eines
  308. einzelnen Elements. Man muß nur <code>setMultiFile()</code> aufrufen nachdem das
  309. Element erstellt wurde:
  310. </para>
  311. <programlisting language="php"><![CDATA[
  312. $element = new Zend_Form_Element_File('foo');
  313. $element->setLabel('Ein Bild hochladen:')
  314. ->setDestination('/var/www/upload');
  315. // Mindestens 1 und maximal 3 Dateien sicherstellen
  316. $element->addValidator('Count', false, array('min' => 1, 'max' => 3));
  317. // Auf 100k limitieren
  318. $element->addValidator('Size', false, 102400);
  319. // Nur JPEG, PNG, und GIFs
  320. $element->addValidator('Extension', false, 'jpg,png,gif');
  321. // 3 identische Dateielemente definieren
  322. $element->setMultiFile(3);
  323. $form->addElement($element, 'foo');
  324. ]]></programlisting>
  325. <para>
  326. In der View erhält man nun 3 identische File Upload Elemente welche alle die
  327. gleichen Einstellungen verwenden. Um die Multifile Anzahl zu erhalten kann man
  328. einfach <code>getMultiFile()</code> aufrufen.
  329. </para>
  330. </example>
  331. <note>
  332. <title>File Elemente in Subformularen</title>
  333. <para>
  334. Wenn File Elemente in Subformularen verwendet werden muß man eindeutige Namen
  335. setzen. Wenn man zum Beispiel ein File Element in Subform1 "file" benennt, muß es in
  336. Subform2 einen anderen Namen erhalten.
  337. </para>
  338. <para>
  339. Sobald es 2 identisch benannte File Elemente gibt, wird das zweite Element entweder
  340. nicht dargestellt oder nicht übertragen.
  341. </para>
  342. </note>
  343. <para>
  344. Um die Größe der Datei zu begrenzen, die vom Client hochgeladen wird, kann die maximale
  345. Dateigröße spezifiziert werden indem die <code>MAX_FILE_SIZE</code> Option im Formular
  346. gesetzt wird. Sobald der Wert, durch die Verwendung der
  347. <code>setMaxFileSize($size)</code> Methode, gesetzt ist, wird er mit dem File Element
  348. dargestellt.
  349. </para>
  350. <programlisting language="php"><![CDATA[
  351. $element = new Zend_Form_Element_File('foo');
  352. $element->setLabel('Ein Bild hochladen:')
  353. ->setDestination('/var/www/upload')
  354. ->addValidator('Size', false, 102400) // Limitiert auf 100k
  355. ->setMaxFileSize(102400); // Limitiert die Dateigröße auf der Clientseite
  356. $form->addElement($element, 'foo');
  357. ]]></programlisting>
  358. <note>
  359. <title>MaxFileSize mit mehreren File Elementen</title>
  360. <para>
  361. Wenn mehrere File Elemente im Formular verwendet werden sollte man
  362. <code>MAX_FILE_SIZE</code> nur einmal setzen. Wird es nochmals gesetzt überschreibt
  363. es den vorherigen Wert.
  364. </para>
  365. <para>
  366. Beachte, das das auch der Fall ist wenn man mehrere Formulare verwendet.
  367. </para>
  368. </note>
  369. </sect2>
  370. <sect2 id="zend.form.standardElements.hidden">
  371. <title>Zend_Form_Element_Hidden</title>
  372. <para>
  373. Versteckte Elemente fügen Daten ein die übertragen werden sollen, welche der Benutzer
  374. aber nicht manipulieren soll. <classname>Zend_Form_Element_Hidden</classname> ermöglicht
  375. das mit dem 'formHidden' View Helfers.
  376. </para>
  377. </sect2>
  378. <sect2 id="zend.form.standardElements.hash">
  379. <title>Zend_Form_Element_Hash</title>
  380. <para>
  381. Dieses Element bietet Schutz vor CSRF Attacken auf Forms, und stellt sicher das die
  382. Daten die übertragen werden von der Benutzersession stammen die die Form erstellt hat
  383. und nicht durch ein bösartiges Skript. Sicherheit wird ermöglicht durch das hinzufügen
  384. eines Hash Elements zur form und dessen Prüfung wenn die Form übermittelt wird.
  385. </para>
  386. <para>
  387. Der Name des Hash Elements sollte einmalig sein. Wir emphehlen die Verwendung der
  388. <literal>salt</literal> Option für das Element- damit zwei Hashes mit dem gleichen
  389. Namen und unterschiedlichen Salts nicht kollidieren:
  390. </para>
  391. <programlisting language="php"><![CDATA[
  392. $form->addElement('hash', 'no_csrf_foo', array('salt' => 'unique'));
  393. ]]></programlisting>
  394. <para>
  395. Das Salt kann später gesetzt werden durch Verwendung der <code>setSalt($salt)</code>
  396. Methode.
  397. </para>
  398. <para>
  399. Intern speichert das Element einen eindeutigen Identifikator indem es
  400. <classname>Zend_Session_Namespace</classname> verwendet, und danach bei der Übertragung
  401. checkt (es wird geprüft das die TTL nicht abgelaufen ist). Die 'Identical' Prüfung wird
  402. Internally, the element stores a unique identifier using
  403. <classname>Zend_Session_Namespace</classname>, and checks for it at
  404. submission (checking that the TTL has not expired). The 'Identical'
  405. validator is then used to ensure the submitted hash matches the
  406. stored hash.
  407. </para>
  408. <para>
  409. Der 'formHidden' View Helfer wird verwendet um das Element in der Form darzustellen.
  410. </para>
  411. </sect2>
  412. <sect2 id="zend.form.standardElements.Image">
  413. <title>Zend_Form_Element_Image</title>
  414. <para>
  415. Bilder können als Form Elemente verwendet werden und man kann diese Bilder als
  416. graphische Elemente auf Form Buttons verwenden.
  417. </para>
  418. <para>
  419. Bilder benötigen eine Bildquelle. <classname>Zend_Form_Element_Image</classname> erlaube
  420. dessen Spezifikation durch Verwendung der <code>setImage()</code> Zugriffsmethode (oder
  421. des 'image' Konfigurations Schlüssels). Es kann auch optional ein Wert spezifiziert
  422. werden der zu verwenden ist wenn das Bild übertragen wird indem die Zugriffsmethode
  423. <code>setImageValue()</code> verwendet wird (oder der 'imageValue Konfigurations
  424. Schlüssel). Wenn der Wert der für das Element gesetzt ist, mit <code>imageValue</code>
  425. übereinstimmt, gibt <code>isChecked()</code> true zurück.
  426. </para>
  427. <para>
  428. Bild Elemente verwenden den
  429. <link linkend="zend.form.standardDecorators.image">Image Decorator</link> für die
  430. Darstellung, zusätzlich zu den Standard Error, HtmlTag und Label Dekoratoren. Es kann
  431. optional ein Tag für den <code>Image</code> Dekorator spezifiziert werden der das
  432. Bild einbettet.
  433. </para>
  434. </sect2>
  435. <sect2 id="zend.form.standardElements.multiCheckbox">
  436. <title>Zend_Form_Element_MultiCheckbox</title>
  437. <para>
  438. Oft hat man ein Set von zusammenhängenden Checkboxen, und die Ergebnisse sollen
  439. gruppiert werden. Das ist so ähnlich wie
  440. <link linkend="zend.form.standardElements.multiselect">Multiselect</link> aber statt
  441. das Sie in einer DropDown Liste sind, müssen Checkbox/Werte Paare dargestellt werden.
  442. </para>
  443. <para>
  444. <classname>Zend_Form_Element_MultiCheckbox</classname> macht das in einem Rutsch. Wie
  445. alle anderen Elemente kann mit der Erweiterung des Basis MultiElements eine Liste von
  446. Optionen spezifiziert werden und einfach gegen die selbe Liste geprüft werden. Der
  447. 'formMultiCheckbox' View Helfer stellt sicher das Sie als Array bei der Übermittlung
  448. der Form zurückgegeben werden.
  449. </para>
  450. <para>
  451. Standardmäßig registriert dieses Element die <code>InArray</code> Prüfung welche gegen
  452. Arrayschlüssel von registrierten Optionen prüft. Dieses Verhalten kann deaktiviert
  453. werden indem entweder <code>setRegisterInArrayValidator(false)</code> aufgerufen, oder
  454. indem ein false Wert an den <code>registerInArrayValidator</code>
  455. Konfigurationsschlüssel übergeben wird.
  456. </para>
  457. <para>
  458. Die verschiedenen Checkbox Optionen können mit den folgenden Methoden manipuliert
  459. werden:
  460. </para>
  461. <itemizedlist>
  462. <listitem><para><code>addMultiOption($option, $value)</code></para></listitem>
  463. <listitem><para><code>addMultiOptions(array $options)</code></para></listitem>
  464. <listitem><para><code>setMultiOptions(array $options)</code> (überschreibt existierende
  465. Optionen)</para></listitem>
  466. <listitem><para><code>getMultiOption($option)</code></para></listitem>
  467. <listitem><para><code>getMultiOptions()</code></para></listitem>
  468. <listitem><para><code>removeMultiOption($option)</code></para></listitem>
  469. <listitem><para><code>clearMultiOptions()</code></para></listitem>
  470. </itemizedlist>
  471. <para>
  472. Um gecheckte Elemente zu markieren, muß ein Array an Werte an <code>setValue()</code>
  473. übergeben werden. Der folgende Code prüft die Werte "bar" und "bat":
  474. </para>
  475. <programlisting language="php"><![CDATA[
  476. $element = new Zend_Form_Element_MultiCheckbox('foo', array(
  477. 'multiOptions' => array(
  478. 'foo' => 'Foo Option',
  479. 'bar' => 'Bar Option',
  480. 'baz' => 'Baz Option',
  481. 'bat' => 'Bat Option',
  482. );
  483. ));
  484. $element->setValue(array('bar', 'bat'));
  485. ]]></programlisting>
  486. <para>
  487. Beachte das man auch für das Setzen eines einzelnen Wertes ein Array übergeben muß.
  488. </para>
  489. </sect2>
  490. <sect2 id="zend.form.standardElements.multiselect">
  491. <title>Zend_Form_Element_Multiselect</title>
  492. <para>
  493. XHTML <code>select</code> Elemente erlaube ein 'multiple' Attribut, das zeigt das
  494. mehrere Optionen für die Übermittlung ausgewählt werden können, statt normalerweise
  495. nur eines. <classname>Zend_Form_Element_Multiselect</classname> erweitert
  496. <link linkend="zend.form.standardElements.select">Zend_Form_Element_Select</link> und
  497. setzt das <code>multiple</code> Attribut auf 'multiple'. Wie andere Klassen die von der
  498. Basisklasse <classname>Zend_Form_Element_Multi</classname> abgeleitet werden, können die
  499. Optionen für die Auswahl wie folgt verändert werden:
  500. </para>
  501. <itemizedlist>
  502. <listitem><para><code>addMultiOption($option, $value)</code></para></listitem>
  503. <listitem><para><code>addMultiOptions(array $options)</code></para></listitem>
  504. <listitem><para><code>setMultiOptions(array $options)</code>
  505. (überschreibt existierende Optionen)</para></listitem>
  506. <listitem><para><code>getMultiOption($option)</code></para></listitem>
  507. <listitem><para><code>getMultiOptions()</code></para></listitem>
  508. <listitem><para><code>removeMultiOption($option)</code></para></listitem>
  509. <listitem><para><code>clearMultiOptions()</code></para></listitem>
  510. </itemizedlist>
  511. <para>
  512. Wenn ein Übersetzungs Adapter in der Form und/oder dem Element registriert ist,
  513. werden Optionswerte für Darstellungzwecke übersetzt.
  514. </para>
  515. <para>
  516. Standardmäßig registriert dieses Element die <code>InArray</code> Prüfung welche gegen
  517. Arrayschlüssel von registrierten Optionen prüft. Dieses Verhalten kann deaktiviert
  518. werden indem entweder <code>setRegisterInArrayValidator(false)</code> aufgerufen, oder
  519. indem ein false Wert an den <code>registerInArrayValidator</code>
  520. Konfigurationsschlüssel übergeben wird.
  521. </para>
  522. </sect2>
  523. <sect2 id="zend.form.standardElements.password">
  524. <title>Zend_Form_Element_Password</title>
  525. <para>
  526. Passwort Element sind grundsätzlich normale Textelemente -- ausser das typischerweise
  527. das eingegebene Passwort nicht in Fehlermeldungen oder dem Element selbst angezeigt
  528. werden soll wenn die Form normals angezeigt wird.
  529. </para>
  530. <para>
  531. <classname>Zend_Form_Element_Password</classname> ermöglicht das durch den Aufruf von
  532. <code>setObscureValue(true)</code> auf jeder Prüfung (und stellt sicher das das
  533. Passwort in der Prüfungs Fehlermeldung verschleiert wird), und verwendet den
  534. 'formPassword' View Helfer (welcher den an Ihn übergebenen Wert nicht anzeigt).
  535. </para>
  536. </sect2>
  537. <sect2 id="zend.form.standardElements.radio">
  538. <title>Zend_Form_Element_Radio</title>
  539. <para>
  540. Radio Elemente erlauben es verschiedene Optionen zu spezifizieren, von denen ein
  541. einzelner Wert zurückgegeben wird. <classname>Zend_Form_Element_Radio</classname>
  542. erweitert die Basisklasse <classname>Zend_Form_Element_Multi</classname> und erlaubt es
  543. eine Anzahl von Optionen zu spezifizieren, und verwendet dann den <code>formRadio</code>
  544. View Helfer um diese darzustellen.
  545. </para>
  546. <para>
  547. Standardmäßig registriert dieses Element die <code>InArray</code> Prüfung welche gegen
  548. Arrayschlüssel von registrierten Optionen prüft. Dieses Verhalten kann deaktiviert
  549. werden indem entweder <code>setRegisterInArrayValidator(false)</code> aufgerufen, oder
  550. indem ein false Wert an den <code>registerInArrayValidator</code>
  551. Konfigurationsschlüssel übergeben wird.
  552. </para>
  553. <para>
  554. Wie alle Elemente die die Basisklasse des Mutli Elements erweitern, können die
  555. folgenden Methode verwendet werden um die Radio Optionen zu manipulieren die angezeigt
  556. werden:
  557. </para>
  558. <itemizedlist>
  559. <listitem><para><code>addMultiOption($option, $value)</code></para></listitem>
  560. <listitem><para><code>addMultiOptions(array $options)</code></para></listitem>
  561. <listitem><para><code>setMultiOptions(array $options)</code>
  562. (überschreibt existierende Optionen)</para></listitem>
  563. <listitem><para><code>getMultiOption($option)</code></para></listitem>
  564. <listitem><para><code>getMultiOptions()</code></para></listitem>
  565. <listitem><para><code>removeMultiOption($option)</code></para></listitem>
  566. <listitem><para><code>clearMultiOptions()</code></para></listitem>
  567. </itemizedlist>
  568. </sect2>
  569. <sect2 id="zend.form.standardElements.reset">
  570. <title>Zend_Form_Element_Reset</title>
  571. <para>
  572. Reset Buttons werden typischerweise verwendet um eine Form zu löschen, und sind nicht
  573. Teil der übermittelten Daten. Da Sie trotzdem einen Zweck in der Anzeige bieten, sind
  574. Sie in den Standardelementen enthalten.
  575. </para>
  576. <para>
  577. <classname>Zend_Form_Element_Reset</classname> erweitert
  578. <link linkend="zend.form.standardElements.submit">Zend_Form_Element_Submit</link>.
  579. Deswegen wird das Label für die Anzeige des Buttons verwendet und wird übersetzt
  580. wenn ein Übersetzungs Adapter vorhanden ist. Es verwendet nur die 'ViewHelper' und
  581. 'DtDdWrapper' Dekoratore, da es nie Fehlermeldungen für solche Elemente geben sollte,
  582. noch sollte ein Label notwendig sein.
  583. </para>
  584. </sect2>
  585. <sect2 id="zend.form.standardElements.select">
  586. <title>Zend_Form_Element_Select</title>
  587. <para>
  588. Auswahlboxen sind der übliche Weg um spezielle Auswahlen für gegebene Formdaten zu
  589. begrenzen. <classname>Zend_Form_Element_Select</classname> erlaubt es diese schnell und
  590. einfach zu erzeugen.
  591. </para>
  592. <para>
  593. Standardmäßig registriert dieses Element die <code>InArray</code> Prüfung welche gegen
  594. Arrayschlüssel von registrierten Optionen prüft. Dieses Verhalten kann deaktiviert
  595. werden indem entweder <code>setRegisterInArrayValidator(false)</code> aufgerufen, oder
  596. indem ein false Wert an den <code>registerInArrayValidator</code>
  597. Konfigurationsschlüssel übergeben wird.
  598. </para>
  599. <para>
  600. Da es das Basis Multielement erweitert, können die folgenden Methoden verwendet werden
  601. um die Auswahloptionen zu manipulieren:
  602. </para>
  603. <itemizedlist>
  604. <listitem><para><code>addMultiOption($option, $value)</code></para></listitem>
  605. <listitem><para><code>addMultiOptions(array $options)</code></para></listitem>
  606. <listitem><para><code>setMultiOptions(array $options)</code>
  607. (überschreibt existierende Optionen)</para></listitem>
  608. <listitem><para><code>getMultiOption($option)</code></para></listitem>
  609. <listitem><para><code>getMultiOptions()</code></para></listitem>
  610. <listitem><para><code>removeMultiOption($option)</code></para></listitem>
  611. <listitem><para><code>clearMultiOptions()</code></para></listitem>
  612. </itemizedlist>
  613. <para>
  614. <classname>Zend_Form_Element_Select</classname> verwendet den 'formSelect' View Helfer
  615. für die Dekoration.
  616. </para>
  617. </sect2>
  618. <sect2 id="zend.form.standardElements.submit">
  619. <title>Zend_Form_Element_Submit</title>
  620. <para>
  621. Sendebuttons (Submit) werden verwendet um eine Form zu senden. Es kann gewünscht sein
  622. mehrere Sendebuttons zu verwendetn; die Buttons zur Übermittlung der Form können
  623. verwendet werden um auszuwählen welche Aktion mit den übermittelten Daten genommen
  624. werden soll. <classname>Zend_Form_Element_Submit</classname> macht die Entscheidung
  625. einfach, durch das Hinzufügen einer <code>isChecked()</code> Methode; da nur ein Button
  626. Element von der Form übermittelt wird, nachdem die Form übermittelt oder geprüft wurde,
  627. kann diese Methode auf jedem Sendebutton ausgerufen werden um festzustellen welcher
  628. verwendet wurde.
  629. </para>
  630. <para>
  631. <classname>Zend_Form_Element_Submit</classname> verwendet das Label als den "Wert" des
  632. Sendebuttons, und übersetzt es wenn ein Übersetzungsadapter vorhanden ist.
  633. <code>isChecked()</code> prüft den übermittelten Wert gegen das Label um festzustellen
  634. ob der Button verwendet wurde.
  635. </para>
  636. <para>
  637. Die <link linkend="zend.form.standardDecorators.viewHelper">ViewHelper</link> und
  638. <link linkend="zend.form.standardDecorators.dtDdWrapper">DtDdWrapper</link> Dekoratore
  639. werden verwendet um das Element darzustellen. Es wird kein Labeldekorator verwendet, da
  640. das Label des Buttons verwendet wird wenn das Element dargestellt wird; typischerweise
  641. werden acuh keine Fehler mit einem Sendeelement assoziiert.
  642. </para>
  643. </sect2>
  644. <sect2 id="zend.form.standardElements.text">
  645. <title>Zend_Form_Element_Text</title>
  646. <para>
  647. Der nützlichste Typ von Form Element ist das Text Element, das begrenzte Texteinträge
  648. erlaubt; es ist ein ideales Element für die meisten Dateneinträge.
  649. <classname>Zend_Form_Element_Text</classname> verwendet einfach den 'formText' View
  650. Helfer um das Element darzustellen.
  651. </para>
  652. </sect2>
  653. <sect2 id="zend.form.standardElements.textarea">
  654. <title>Zend_Form_Element_Textarea</title>
  655. <para>
  656. Textbereiche werden verwendet wenn große Mengen von Text erwartet werden, und keine
  657. Begrenzung in der Anzahl des übermittelten Textes vorhanden sind (anders als das Limit
  658. der Maximalgröße wie vom Server von PHP diktiert).
  659. <classname>Zend_Form_Element_Textarea</classname> verwendet den 'textArea' View Helfer
  660. um solche Element darzustellen, und platziert den Wert als Inhalt des Elements.
  661. </para>
  662. </sect2>
  663. </sect1>
  664. <!--
  665. vim:se ts=4 sw=4 tw=80 et:
  666. -->