Zend_Form-StandardElements.xml 36 KB

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