Zend_Form-StandardElements.xml 34 KB

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