Zend_Form-Elements.xml 68 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.form.elements">
  5. <title>Erstellen von Form Elementen mit Hilfe von Zend_Form_Element</title>
  6. <para>
  7. Ein Formular ist aus Elementen gemacht, die typischerweise mit einer <acronym>HTML</acronym>
  8. Form Eingabe korrespondieren. <classname>Zend_Form_Element</classname> kapselt einzelne
  9. Formularelemente mit den folgenden Bereichen die erfüllt werden sollen:
  10. </para>
  11. <itemizedlist>
  12. <listitem>
  13. <para>
  14. Prüfung (ist der übertragene Wert gültig?)
  15. </para>
  16. <itemizedlist>
  17. <listitem>
  18. <para>Fangen von Fehlercodes und Nachrichten von Prüfungen</para>
  19. </listitem>
  20. </itemizedlist>
  21. </listitem>
  22. <listitem>
  23. <para>
  24. Filtern (wie wird das Element in Anführungsstriche gesetzt oder normalisiert bevor
  25. die Prüfung stattfinden und/oder für die Ausgabe?)
  26. </para>
  27. </listitem>
  28. <listitem>
  29. <para>Darstellung (wie wird das Element angezeigt?)</para>
  30. </listitem>
  31. <listitem>
  32. <para>
  33. Metadaten und Attribute (welche Informationen qualifizieren das Element näher?)
  34. </para>
  35. </listitem>
  36. </itemizedlist>
  37. <para>
  38. Die Basisklasse, <classname>Zend_Form_Element</classname>, hat begründete Standardwerte für
  39. viele Fälle, aber es ist am besten die Klasse zu erweitern für oft verwendete speziell
  40. benötigte Elemente. Zusätzlich wird Zend Framework mit einer Anzahl an Standard
  41. <acronym>XHTML</acronym> Elementen ausgeliefert; über diese kann im
  42. <link linkend="zend.form.standardElements">Kapitel über Standard Elemente</link>
  43. nachgelesen werden.
  44. </para>
  45. <sect2 id="zend.form.elements.loaders">
  46. <title>Plugin Loader</title>
  47. <para>
  48. <classname>Zend_Form_Element</classname> verwendet
  49. <link linkend="zend.loader.pluginloader">Zend_Loader_PluginLoader</link> um es
  50. Entwicklern zu erlauben Orte für alternative Prüfungen, Filter und Dekoratoren zu
  51. definieren. Jeder hat seinen eigenen Plugin Loader assoziiert, und generelle
  52. Zugriffspunkte werden verwendet um jeden zu empfangen oder zu ändern.
  53. </para>
  54. <para>
  55. Die folgenden Ladetypen werden mit den verschiedenen Plugin Loader Methoden verwendet:
  56. 'validate', 'filter', und 'decorator'. Die Typnamen sind unabhängig von der
  57. Schreibweise.
  58. </para>
  59. <para>
  60. Die Methoden die für die Interaktion mit Plugin Loadern verwendet werden, sind die
  61. folgenden:
  62. </para>
  63. <itemizedlist>
  64. <listitem>
  65. <para>
  66. <methodname>setPluginLoader($loader, $type)</methodname>:
  67. <varname>$loader</varname> ist das Plugin Loader Objekt selbst, während
  68. <varname>$type</varname> eine der oben spezifizierten Typen ist. Das setzt den
  69. Plugin Loader für den gegebenen Typ auf das neu spezifizierte Loader Objekt.
  70. </para>
  71. </listitem>
  72. <listitem>
  73. <para>
  74. <methodname>getPluginLoader($type)</methodname>: Empfängt den mit
  75. <varname>$type</varname> assoziierten Plugin Loader.
  76. </para>
  77. </listitem>
  78. <listitem>
  79. <para>
  80. <methodname>addPrefixPath($prefix, $path, $type = null)</methodname>: Fügt eine
  81. Präfix/Pfad Assoziation hinzu, Wenn <varname>$type</varname>
  82. <constant>FALSE</constant> ist, wird versucht den Pfad zu allen Loadern
  83. hinzuzufügen durch anhängen des Präfix von jedem "_Validate", "_Filter", und
  84. "_Decorator"; und anhängen des Pfades an "Validate/", "Filter/", und
  85. "Decorator/". Wenn alle extra Formular Elementklassen unter einer üblichen
  86. Hirarchie stehen, ist das die bequemste Methode für das Setzen von
  87. grundsätzlichen Präfixen.
  88. </para>
  89. </listitem>
  90. <listitem>
  91. <para>
  92. <methodname>addPrefixPaths(array $spec)</methodname>: Erlaubt es viele Pfade auf
  93. einmal zu einem oder mehreren Plugin Loadern hinzuzufügen. Sie erwartet das
  94. jedes Arrayelement ein Array mit den Sclüsseln 'path', 'prefix' und 'type' ist.
  95. </para>
  96. </listitem>
  97. </itemizedlist>
  98. <para>
  99. Eigene Prüfungen, Filter und Dekoratoren sind ein einfacher Weg um Funktionalität
  100. zwischen Forms zu teilen und eigene Funktionalitäten zu kapseln.
  101. </para>
  102. <example id="zend.form.elements.loaders.customLabel">
  103. <title>Eigenes Label</title>
  104. <para>
  105. Ein üblicher Verwendungszweck ist es Ersetzungen für Standardklassen anzubieten.
  106. Zum Beispiel wenn man eine andere Implementation des 'Label' Dekorators anbieten
  107. will -- zum Beispiel um immer einen Bindestrich anzufügen -- dann könnte man einen
  108. eigenen 'Label' Dekorator mit einem eigenen Klassenpräfix erstellen, und diesen
  109. zum eigenen Präfix Pfad hinzufügen.
  110. </para>
  111. <para>
  112. Beginnen wir mit einem eigenen Label Dekorator. Wir geben ihm den Klassenpräfix
  113. "My_Decorator", und die Klasse selbst wird in der Datei "My/Decorator/Label.php"
  114. sein.
  115. </para>
  116. <programlisting language="php"><![CDATA[
  117. class My_Decorator_Label extends Zend_Form_Decorator_Abstract
  118. {
  119. protected $_placement = 'PREPEND';
  120. public function render($content)
  121. {
  122. if (null === ($element = $this->getElement())) {
  123. return $content;
  124. }
  125. if (!method_exists($element, 'getLabel')) {
  126. return $content;
  127. }
  128. $label = $element->getLabel() . ':';
  129. if (null === ($view = $element->getView())) {
  130. return $this->renderLabel($content, $label);
  131. }
  132. $label = $view->formLabel($element->getName(), $label);
  133. return $this->renderLabel($content, $label);
  134. }
  135. public function renderLabel($content, $label)
  136. {
  137. $placement = $this->getPlacement();
  138. $separator = $this->getSeparator();
  139. switch ($placement) {
  140. case 'APPEND':
  141. return $content . $separator . $label;
  142. case 'PREPEND':
  143. default:
  144. return $label . $separator . $content;
  145. }
  146. }
  147. }
  148. ]]></programlisting>
  149. <para>
  150. Jetzt kann dem Element mitgeteilt werden diesen Plugin Pfad zu verwenden wenn
  151. nach Dekoratoren gesucht wird:
  152. </para>
  153. <programlisting language="php"><![CDATA[
  154. $element->addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator');
  155. ]]></programlisting>
  156. <para>
  157. Alternativ kann das bei der Form gemacht werden um sicherzustellen das alle
  158. Dekoratore diesen Pfad verwenden:
  159. </para>
  160. <programlisting language="php"><![CDATA[
  161. $form->addElementPrefixPath('My_Decorator', 'My/Decorator/', 'decorator');
  162. ]]></programlisting>
  163. <para>
  164. Wird dieser Pfad hinzugefügt, wenn ein Dekorator hinzugefügt wird, wird der
  165. Pfad 'My/Decorator/' zuerst durchsucht um zu sehen ob der Dekorator dort existiert.
  166. Als Ergebnis wird 'My_Decorator_Label' jetzt verwendet wenn der 'Labe' Dekorator
  167. angefragt wird.
  168. </para>
  169. </example>
  170. </sect2>
  171. <sect2 id="zend.form.elements.filters">
  172. <title>Filter</title>
  173. <para>
  174. Es ist oft nützlich und/oder notwendig einige Normalisierungen an Eingaben vorzunehmen,
  175. bevor diese geprüft werden - zum Beispiel kann es gewünscht sein alles an
  176. <acronym>HTML</acronym> zu entfernen, aber die Prüfungen auf dem verbleibenden
  177. durchzuführen um sicherzustellen, dass die Übertragung gültig ist. Oder man will
  178. Leerzeichen bei Eingaben entfernen, damit eine StringLength Prüfung kein falsches
  179. "Korrekt" zurückgibt. Diese Operationen können durchgeführt werden indem
  180. <classname>Zend_Filter</classname> verwendet wird, und
  181. <classname>Zend_Form_Element</classname> unterstützt Filterketten, was es erlaubt
  182. mehrere, sequentielle Filter zu spezifizieren und anzupassen. Das Filtern geschieht
  183. während der Prüfung und wenn der Wert des Elements über
  184. <methodname>getValue()</methodname> geholt wird:
  185. </para>
  186. <programlisting language="php"><![CDATA[
  187. $filtered = $element->getValue();
  188. ]]></programlisting>
  189. <para>
  190. Filter können der Kette auf zwei Wegen hinzugefügt werden:
  191. </para>
  192. <itemizedlist>
  193. <listitem><para>Übergabe einer konkreten Filterinstanz</para></listitem>
  194. <listitem>
  195. <para>
  196. Angabe eines kurzen Filternamens
  197. </para>
  198. </listitem>
  199. </itemizedlist>
  200. <para>
  201. Sehen wir uns einige Beispiele an:
  202. </para>
  203. <programlisting language="php"><![CDATA[
  204. // Konkrete Filterinstanz:
  205. $element->addFilter(new Zend_Filter_Alnum());
  206. // Kurzname des Filters:
  207. $element->addFilter('Alnum');
  208. $element->addFilter('alnum');
  209. ]]></programlisting>
  210. <para>
  211. Kurznamen sind typischerweise der Filtername ohne den Präfix. Im Standardfall bedeutet
  212. das keinen 'Zend_Filter_' Präfix. Zusätzlich muss der erste Buchstabe nicht
  213. großgeschrieben werden.
  214. </para>
  215. <note>
  216. <title>Eigene Filterklassen verwenden</title>
  217. <para>
  218. Wenn man sein eigenes Set an Filterklassen hat, kann man
  219. <classname>Zend_Form_Element</classname> mitteilen diese zu verwenden indem
  220. <methodname>addPrefixPath()</methodname> verwendet wird. Wenn man zum Beispiel
  221. eigene Filter unter dem 'My_Filter' Präfix hat, kann
  222. <classname>Zend_Form_Element</classname> dies auf dem folgenden Weg mitgeteilt
  223. werden:
  224. </para>
  225. <programlisting language="php"><![CDATA[
  226. $element->addPrefixPath('My_Filter', 'My/Filter/', 'filter');
  227. ]]></programlisting>
  228. <para>
  229. (Beachten Sie, dass das dritte Agument indiziert welcher Plugin Loader auf welcher
  230. Aktion durchgeführt werden soll.)
  231. </para>
  232. </note>
  233. <para>
  234. Wenn man zu irgendeiner Zeit den ungefilterten Wert benötigt, kann die
  235. <methodname>getUnfilteredValue()</methodname> Methode verwendet werden:
  236. </para>
  237. <programlisting language="php"><![CDATA[
  238. $unfiltered = $element->getUnfilteredValue();
  239. ]]></programlisting>
  240. <para>
  241. Für weitere Informationen über Filter, siehe die
  242. <link linkend="zend.filter.introduction">Dokumentation über Zend_Filter</link>.
  243. </para>
  244. <para>
  245. Die Methoden die mit Filtern assoziiert sind, beinhalten:
  246. </para>
  247. <itemizedlist>
  248. <listitem>
  249. <para>
  250. <methodname>addFilter($nameOfFilter, array $options = null)</methodname>
  251. </para>
  252. </listitem>
  253. <listitem><para><methodname>addFilters(array $filters)</methodname></para></listitem>
  254. <listitem>
  255. <para>
  256. <methodname>setFilters(array $filters)</methodname> (Überschreibt alle Filter)
  257. </para>
  258. </listitem>
  259. <listitem>
  260. <para>
  261. <methodname>getFilter($name)</methodname> (Empfängt ein Filterobjekt durch
  262. seinen Namen)
  263. </para>
  264. </listitem>
  265. <listitem>
  266. <para><methodname>getFilters()</methodname> (Empfängt alle Filter)</para>
  267. </listitem>
  268. <listitem>
  269. <para>
  270. <methodname>removeFilter($name)</methodname> (Entfernt einen Filter durch seinen
  271. Namen)
  272. </para>
  273. </listitem>
  274. <listitem>
  275. <para><methodname>clearFilters()</methodname> (Entfernt alle Filter)</para>
  276. </listitem>
  277. </itemizedlist>
  278. </sect2>
  279. <sect2 id="zend.form.elements.validators">
  280. <title>Prüfungen</title>
  281. <para>
  282. Wenn man das Sicherheits-Mantra von "Eingabe filtern, Ausgabe escapen" unterschreibt
  283. dann wird man die Eingabe des Formulars prüfen ("Eingabefilterung") wollen. In
  284. <classname>Zend_Form</classname> enthält jedes Element seine eigene Prüfkette, die aus
  285. <classname>Zend_Validate_*</classname> Prüfungen besteht.
  286. </para>
  287. <para>
  288. Prüfungen können der Kette auf zwei Wegen hinzugefügt werden:
  289. </para>
  290. <itemizedlist>
  291. <listitem><para>Übergabe einer konkreten Prüfinstanz</para></listitem>
  292. <listitem>
  293. <para>
  294. Anbieten eines kurzen Prüfnamens
  295. </para>
  296. </listitem>
  297. </itemizedlist>
  298. <para>
  299. Einige Beispiele:
  300. </para>
  301. <programlisting language="php"><![CDATA[
  302. // Konkrete Prüfinstanz:
  303. $element->addValidator(new Zend_Validate_Alnum());
  304. // Kurzer Prüfname:
  305. $element->addValidator('Alnum');
  306. $element->addValidator('alnum');
  307. ]]></programlisting>
  308. <para>
  309. Kurznamen sind typischerweise der Prüfname ohne den Präfix. Im Standardfall bedeutet
  310. das, keinen 'Zend_Validate_' Präfix. Zusätzlich muss der erste Buchstabe nicht
  311. großgeschrieben werden.
  312. </para>
  313. <note>
  314. <title>Eigene Prüfklassen verwenden</title>
  315. <para>
  316. Wenn man sein eigenes Set an Prüfklassen hat, kann man
  317. <classname>Zend_Form_Element</classname> mitteilen diese zu verwenden indem
  318. <methodname>addPrefixPath()</methodname> verwendet wird. Wenn man zum Beispiel
  319. eigene Prüfungen unter dem 'My_Validator' Präfix hat, kann
  320. <classname>Zend_Form_Element</classname> dies auf dem folgenden Weg mitgeteilt
  321. werden:
  322. </para>
  323. <programlisting language="php"><![CDATA[
  324. $element->addPrefixPath('My_Validator', 'My/Validator/', 'validate');
  325. ]]></programlisting>
  326. <para>
  327. (Beachten Sie dass das dritte Agument zeigt welcher Plugin Loader auf welcher
  328. Aktion durchgeführt werden soll)
  329. </para>
  330. </note>
  331. <para>
  332. Wenn eine bestimmte Prüfung fehlschlägt, und die Ausführung von späteren Prüfungen
  333. verhindert werden soll, kann ein <constant>TRUE</constant> als zweiter Parameter
  334. übergeben werden:
  335. </para>
  336. <programlisting language="php"><![CDATA[
  337. $element->addValidator('alnum', true);
  338. ]]></programlisting>
  339. <para>
  340. Wenn ein Stringname verwendet wird, um eine Prüfung hinzuzufügen und die Prüfklasse
  341. Argumente in ihrem Konstruktor akzeptiert, können diese als dritter Parameter an
  342. <methodname>addValidator()</methodname> als Array übergeben werden:
  343. </para>
  344. <programlisting language="php"><![CDATA[
  345. $element->addValidator('StringLength', false, array(6, 20));
  346. ]]></programlisting>
  347. <para>
  348. Argumente die auf diesem Weg übergeben werden, sollten in der Reihenfolge sein in der
  349. sie im Konstruktor definiert sind. Das obige Beispiel instanziert die
  350. <classname>Zend_Validate_StringLenth</classname> Klasse mit den <varname>$min</varname>
  351. und <varname>$max</varname> Parametern:
  352. </para>
  353. <programlisting language="php"><![CDATA[
  354. $validator = new Zend_Validate_StringLength(6, 20);
  355. ]]></programlisting>
  356. <note>
  357. <title>Eigene Fehlermeldungen für Prüfungen anbieten</title>
  358. <para>
  359. Einige Entwickler wollen eigene Fehlermeldungen für eine Prüfung anbieten.
  360. <methodname>Zend_Form_Element::addValidator()</methodname>'s
  361. <varname>$options</varname> Argument erlaubt es das zu tun, indem der Schlüssel
  362. 'messages' angegeben wird und ein Array mit Schlüssel/Wert Paaren genutzt wird für
  363. das Setzen der Nachrichten Templates. Man muss die Fehlermeldungen der betreffenden
  364. Prüfung für die verschiedenen Fehlertypen von Prüfungen kennen.
  365. </para>
  366. <para>
  367. Eine bessere Option ist es <classname>Zend_Translate_Adapter</classname> in Formular
  368. zu verwenden. Fehlercodes werden automatisch dem Adapter durch den Standardmäßigen
  369. Fehlerdekorator übergeben; man kann durch die Erstellung von Übersetzungen
  370. eigene Fehlermeldungen für die verschiedenen Fehlercodes der Prüfung definieren.
  371. </para>
  372. </note>
  373. <para>
  374. Es können auch viele Prüfungen auf einmal gesetzt werden, indem
  375. <methodname>addValidators()</methodname> verwendet wird. Die grundsätzliche Verwendung
  376. ist es ein Array von Arrays zu übergeben, wobei jedes Array ein bis drei Werte enthält,
  377. die dem Konstruktor von <methodname>addValidator()</methodname> entsprechen:
  378. </para>
  379. <programlisting language="php"><![CDATA[
  380. $element->addValidators(array(
  381. array('NotEmpty', true),
  382. array('alnum'),
  383. array('stringLength', false, array(6, 20)),
  384. ));
  385. ]]></programlisting>
  386. <para>
  387. Wenn man wortreicher oder expliziter sein will, dann können die Arrayschlüssel
  388. 'validator', 'breakChainOnFailure', und 'options' verwendet werden:
  389. </para>
  390. <programlisting language="php"><![CDATA[
  391. $element->addValidators(array(
  392. array(
  393. 'validator' => 'NotEmpty',
  394. 'breakChainOnFailure' => true),
  395. array('validator' => 'alnum'),
  396. array(
  397. 'validator' => 'stringLength',
  398. 'options' => array(6, 20)),
  399. ));
  400. ]]></programlisting>
  401. <para>
  402. Die Verwendung ist gut für die Illustration wie Prüfungen in einer Konfigurationsdatei
  403. definiert werden können:
  404. </para>
  405. <programlisting language="ini"><![CDATA[
  406. element.validators.notempty.validator = "NotEmpty"
  407. element.validators.notempty.breakChainOnFailure = true
  408. element.validators.alnum.validator = "Alnum"
  409. element.validators.strlen.validator = "StringLength"
  410. element.validators.strlen.options.min = 6
  411. element.validators.strlen.options.max = 20
  412. ]]></programlisting>
  413. <para>
  414. Es ist zu beachten, dass jedes Element einen Schlüssel hat, egal ob er benötigt wird
  415. oder nicht; das ist eine Einschränkung bei der Verwendung von Konfigurationsdateien --
  416. aber es macht auch klar, für was die Argumente stehen. Es ist einfach zu beachten das
  417. jede Prüfungsoption in der richtigen Reihenfolge spezifiziert werden muss.
  418. </para>
  419. <para>
  420. Um ein Element zu prüfen, muss der Wert an <methodname>isValid()</methodname> übergeben
  421. werden:
  422. </para>
  423. <programlisting language="php"><![CDATA[
  424. if ($element->isValid($value)) {
  425. // gülig
  426. } else {
  427. // ungültig
  428. }
  429. ]]></programlisting>
  430. <note>
  431. <title>Die Prüfung findet an gefilterten Werte statt</title>
  432. <para>
  433. <methodname>Zend_Form_Element::isValid()</methodname> filtert Werte durch die
  434. angegebene Filterkette vor der Überprüfung. Siehe das
  435. <link linkend="zend.form.elements.filters">Kapitel über Filter</link> für
  436. weitere Informationen.
  437. </para>
  438. </note>
  439. <note>
  440. <title>Prüfungskontext</title>
  441. <para>
  442. <methodname>Zend_Form_Element::isValid()</methodname> unterstützt ein zusätzliches
  443. Argument <varname>$context</varname>. <methodname>Zend_Form::isValid()</methodname>
  444. übergibt ein komplettes Array von Daten die bearbeitet werden an
  445. <varname>$context</varname>, wenn ein Formular geprüft wird und
  446. <methodname>Zend_Form_Element::isValid()</methodname> übergibt es an jede Prüfung.
  447. Das bedeutet, dass man Prüfungen schreiben kann, die auf die Daten die an andere
  448. Formulare übergeben werden acht geben. Als Beispiel nehmen wir ein Anmeldeformular,
  449. welches die Felder für Passwort und Passwort Wiederholung hat; eine Prüfung würde
  450. sein, dass beide Felder den selben Wert beinhalten. So eine Prüfung könnte wie folgt
  451. aussehen:
  452. </para>
  453. <programlisting language="php"><![CDATA[
  454. class My_Validate_PasswordConfirmation extends Zend_Validate_Abstract
  455. {
  456. const NOT_MATCH = 'notMatch';
  457. protected $_messageTemplates = array(
  458. self::NOT_MATCH => 'Die Passwortüberprüfung war nicht erfolgreich'
  459. );
  460. public function isValid($value, $context = null)
  461. {
  462. $value = (string) $value;
  463. $this->_setValue($value);
  464. if (is_array($context)) {
  465. if (isset($context['password_confirm'])
  466. && ($value == $context['password_confirm']))
  467. {
  468. return true;
  469. }
  470. } elseif (is_string($context) && ($value == $context)) {
  471. return true;
  472. }
  473. $this->_error(self::NOT_MATCH);
  474. return false;
  475. }
  476. }
  477. ]]></programlisting>
  478. </note>
  479. <para>
  480. Prüfungen werden in der Reihenfolge ausgeführt. Jede Prüfung wird ausgeführt solange bis
  481. eine Prüfung die mit einem <constant>TRUE</constant> Wert für
  482. <varname>$breakChainOnFailure</varname> bei Ihrer Prüfung fehlschlägt. Man sollte
  483. sichergehen, dass Prüfungen in einer begründeten Reihenfolge definiert werden.
  484. </para>
  485. <para>
  486. Nach einer fehlgeschlagenen Prüfung können Fehlercodes und Nachrichten von der
  487. Prüfkette empfangen werden:
  488. </para>
  489. <programlisting language="php"><![CDATA[
  490. $errors = $element->getErrors();
  491. $messages = $element->getMessages();
  492. ]]></programlisting>
  493. <para>
  494. (Achtung: zurückgegebene Fehlermeldungen sind ein assoziatives Array von
  495. Fehlercode/Fehlermeldung Paaren.)
  496. </para>
  497. <para>
  498. Zusätzlich zu Prüfungen, kann spezifiziert werden, dass ein Element benötigt wird,
  499. indem <methodname>setRequired($flag)</methodname> verwendet wird. Standardmäßig ist
  500. dieses Flag <constant>FALSE</constant>. In Kombination mit
  501. <methodname>setAllowEmpty($flag)</methodname> (Standardmäßig <constant>TRUE</constant>)
  502. und <methodname>setAutoInsertNotEmptyValidator($flag)</methodname> (standardmäßig
  503. <constant>TRUE</constant>), kann das Verhalten der Prüfkette auf unterschiedliche Art
  504. und Weise verändert werden:
  505. </para>
  506. <itemizedlist>
  507. <listitem>
  508. <para>
  509. Bei Verwendung der Standardwerte werden beim Prüfen eines Elements ohne der
  510. Übergabe eines Werts, oder der Übergabe eines leeren Strings, alle Prüfungen
  511. übersprungen und <constant>TRUE</constant> zurückgegeben.
  512. </para>
  513. </listitem>
  514. <listitem>
  515. <para>
  516. <methodname>setAllowEmpty(false)</methodname> prüft, wenn die anderen zwei
  517. erwähnten Flags unberührt bleiben, gegen die Prüfkette welche für dieses Element
  518. definiert wurde, unabhängig von dem an <methodname>isValid()</methodname>
  519. übergebenen Wert.
  520. </para>
  521. </listitem>
  522. <listitem>
  523. <para>
  524. <methodname>setRequired(true)</methodname> fügt, wenn die anderen zwei
  525. erwähnten Flags unberührt bleiben, eine 'NotEmpty' Prüfung an den Beginn der
  526. Prüfkette (wenn nicht bereits eine gesetzt wurde) wobei das
  527. <varname>$breakChainOnFailure</varname> Flag gesetzt wird. Das heißt, dass das
  528. Flag folgende semantische Bedeutung bekommt: Wenn kein Wert übergeben wird, wird
  529. die Übertragung sofort ungülig und der Benutzer wird informiert, was die anderen
  530. Prüfungen davon abhält, ausgeführt zu werden, auf Daten, von denen wir bereits
  531. wissen, dass sie ungültig sind.
  532. </para>
  533. <para>
  534. Wenn dieses Verhalten nicht gewünscht ist kann es durch die Übergabe eines
  535. <constant>FALSE</constant> Wert an
  536. <methodname>setAutoInsertNotEmptyValidator($flag)</methodname> ausgeschaltet
  537. werden; das verhindert, dass <methodname>isValid()</methodname> die 'NotEmpty'
  538. Prüfung in der Prüfkette platziert.
  539. </para>
  540. </listitem>
  541. </itemizedlist>
  542. <para>
  543. Für weitere Informationen über Prüfungen kann in die
  544. <link linkend="zend.validate.introduction">Zend_Validate Dokumentation</link>
  545. gesehen werden.
  546. </para>
  547. <note>
  548. <title>Verwenden von Zend_Form_Elements als generell-eingesetzte Prüfung</title>
  549. <para>
  550. <classname>Zend_Form_Element</classname> implementiert
  551. <classname>Zend_Validate_Interface</classname> was bedeutet das ein Element auch als
  552. Prüfung füreinander verwendet werden kann, bezüglich nicht-Formular Prüfketten.
  553. </para>
  554. </note>
  555. <note>
  556. <title>Wann wird ein Element als leer erkannt?</title>
  557. <para>
  558. Wie erwähnt wird der 'NotEmpty' Prüfer verwendet um zu erkennen ob ein Element leer
  559. ist oder nicht. Aber <classname>Zend_Validate_NotEmpty</classname> arbeitet
  560. standardmäßig nicht wie <acronym>PHP</acronym>'s <methodname>empty()</methodname>
  561. Methode.
  562. </para>
  563. <para>
  564. Das bedeutet, wenn ein Element ein Integer <emphasis>0</emphasis> oder einen
  565. <emphasis>'0'</emphasis> String enthält dann wird dieses Element als nicht leer
  566. engesehen. Wenn man ein anderes Verhalten will, muss man seine eigene Instanz von
  567. <classname>Zend_Validate_NotEmpty</classname> erstellen. Dort kann man das Verhalten
  568. dieser Prüfung definieren. Siehe <ulink
  569. url="zend.validate.set.notempty">Zend_Validate_NotEmpty</ulink> für Details.
  570. </para>
  571. </note>
  572. <para>
  573. Die mit der Prüfung assoziierten Methoden sind:
  574. </para>
  575. <itemizedlist>
  576. <listitem>
  577. <para>
  578. <methodname>setRequired($flag)</methodname> und
  579. <methodname>isRequired()</methodname> erlauben es den Status des 'required'
  580. Flag zu setzen und zu empfangen. Wenn der Wert auf <constant>TRUE</constant>
  581. gesetzt wird, erzwingt dieses Flag, dass das Element, in den Daten die von
  582. <classname>Zend_Form</classname> bearbeitet werden, vorhanden ist.
  583. </para>
  584. </listitem>
  585. <listitem>
  586. <para>
  587. <methodname>setAllowEmpty($flag)</methodname> und
  588. <methodname>getAllowEmpty()</methodname> erlauben es das Verhalten von
  589. optionalen Elementen (z.B. Elementen in denen das 'required' Flag
  590. <constant>FALSE</constant> ist) zu ändern. Wenn das 'allowEmpty' Flag
  591. <constant>TRUE</constant> ist, werden leere Werte nicht an die Prüfkette
  592. übergeben.
  593. </para>
  594. </listitem>
  595. <listitem>
  596. <para>
  597. <methodname>setAutoInsertNotEmptyValidator($flag)</methodname> erlaubt es zu
  598. definieren ob eine 'NotEmpty' Prüfung der Prüfkette vorangestellt wird wenn das
  599. Element benötigt wird. Standardmäßig ist dieses Flag <constant>TRUE</constant>.
  600. </para>
  601. </listitem>
  602. <listitem>
  603. <para>
  604. <methodname>addValidator($nameOrValidator, $breakChainOnFailure = false, array
  605. $options = null)</methodname>
  606. </para>
  607. </listitem>
  608. <listitem>
  609. <para><methodname>addValidators(array $validators)</methodname></para>
  610. </listitem>
  611. <listitem>
  612. <para>
  613. <methodname>setValidators(array $validators)</methodname> (Überschreibt alle
  614. Prüfer)
  615. </para>
  616. </listitem>
  617. <listitem>
  618. <para>
  619. <methodname>getValidator($name)</methodname> (Empfängt ein Prüfobjekt durch
  620. seinen Namen)
  621. </para>
  622. </listitem>
  623. <listitem>
  624. <para><methodname>getValidators()</methodname> (Empfängt alle Prüfer)</para>
  625. </listitem>
  626. <listitem>
  627. <para>
  628. <methodname>removeValidator($name)</methodname> (Entfernt einen Prüfer durch
  629. seinen Namen)
  630. </para>
  631. </listitem>
  632. <listitem>
  633. <para><methodname>clearValidators()</methodname> (Entfernt alle Prüfer)</para>
  634. </listitem>
  635. </itemizedlist>
  636. <sect3 id="zend.form.elements.validators.errors">
  637. <title>Eigene Fehlermeldungen</title>
  638. <para>
  639. Von Zeit zu Zeit ist es gewünscht ein oder mehrere spezielle Fehlermeldungen zu
  640. spezifizieren, die statt der Fehlermeldungen verwendet werden sollen, die von den
  641. Validatoren verwendet werden, die dem Element angehängt sind. Zusätzlich will man
  642. von Zeit zu Zeit ein Element selbst als ungültig markieren. Ab Version 1.6.0 des
  643. Zend Frameworks ist diese Funktionalität über die folgenden Methoden möglich.
  644. </para>
  645. <itemizedlist>
  646. <listitem>
  647. <para>
  648. <methodname>addErrorMessage($message)</methodname>: Fügt eine Fehlermeldung
  649. hinzu, die bei Formular-Überprüfungs-Fehlern angezeigt wird. Sie kann mehr
  650. als einmal aufgerufen werden, und neue Meldungen werden dem Stack angehängt.
  651. </para>
  652. </listitem>
  653. <listitem>
  654. <para>
  655. <methodname>addErrorMessages(array $messages)</methodname>: Fügt mehrere
  656. Fehlermeldungen hinzu, die bei Formular-Überprüfungs-Fehlern angezeigt
  657. werden.
  658. </para>
  659. </listitem>
  660. <listitem>
  661. <para>
  662. <methodname>setErrorMessages(array $messages)</methodname>: Fügt mehrere
  663. Fehlermeldungen hinzu, die bei Formular-Überprüfungs-Fehlern angezeigt
  664. werden, und überschreibt alle vorher gesetzten Fehlermeldungen.
  665. </para>
  666. </listitem>
  667. <listitem>
  668. <para>
  669. <methodname>getErrorMessages()</methodname>: Empfängt eine Liste von
  670. selbstdefinierten Fehlermeldungen, die vorher definiert wurden.
  671. </para>
  672. </listitem>
  673. <listitem>
  674. <para>
  675. <methodname>clearErrorMessages()</methodname>: Entfernt alle eigenen
  676. Fehlermeldungen, die vorher definiert wurden.
  677. </para>
  678. </listitem>
  679. <listitem>
  680. <para>
  681. <methodname>markAsError()</methodname>: Markiert das Element, wie, wenn die
  682. Überprüfung fehlgeschlagen wäre.
  683. </para>
  684. </listitem>
  685. <listitem>
  686. <para>
  687. <methodname>hasErrors()</methodname>: Erkennt, ob ein Element eine
  688. Überprüfung nicht bestanden hat oder, ob es als ungültig markiert wurde.
  689. </para>
  690. </listitem>
  691. <listitem>
  692. <para>
  693. <methodname>addError($message)</methodname>: Fügt einen Fehler zum eigenen
  694. Stack der Fehlermeldungen hinzu und markiert das Element als ungültig.
  695. </para>
  696. </listitem>
  697. <listitem>
  698. <para>
  699. <methodname>addErrors(array $messages)</methodname>: Fügt mehrere
  700. Nachrichten zum eigenen Stack der Fehlermeldungen hinzu und markiert das
  701. Element als ungültig.
  702. </para>
  703. </listitem>
  704. <listitem>
  705. <para>
  706. <methodname>setErrors(array $messages)</methodname>: Überschreibt den
  707. eigenen Stack der Fehlermeldungen mit den angegebenen Meldungen und markiert
  708. das Element als ungültig.
  709. </para>
  710. </listitem>
  711. </itemizedlist>
  712. <para>
  713. Alle Fehler die auf diesem Weg gesetzt werden, können übersetzt werden. Zusätzlich
  714. kann der Platzhalter "%value%" eingefügt werden um den Wert des Elements zu
  715. repräsentieren; dieser aktuelle Wert des Element wird eingefügt wenn die
  716. Fehlermeldung empfangen wird.
  717. </para>
  718. </sect3>
  719. </sect2>
  720. <sect2 id="zend.form.elements.decorators">
  721. <title>Dekoratoren</title>
  722. <para>
  723. Ein möglicher Schmerzpunkt für viele Webentwickler, ist die Erstellung von
  724. <acronym>XHTML</acronym> Formularen selbst. Für jedes Element muss der Entwickler das
  725. Markup für das Element selbst erstellen, typischerweise ein Label und, wenn sie nett zu
  726. den Benutzern sind, das Markup für die Anzeige von Fehlermeldungen von Prüfungen. Je
  727. mehr Elemente auf einer Seite sind, desto weniger trivial wird diese Aufgabe.
  728. </para>
  729. <para>
  730. <classname>Zend_Form_Element</classname> versucht dieses Problem durch die Verwendung
  731. von "Dekoratoren" zu lösen. Dekoratoren sind Klassen die Zugriff auf das Element
  732. haben und eine Methode zur Darstellung des Inhalts bieten. Für weitere Informationen
  733. darüber wie Dekoratoren arbeiten, kann im Kapitel über
  734. <link linkend="zend.form.decorators">Zend_Form_Decorator</link> eingesehen werden.
  735. </para>
  736. <para>
  737. Die von <classname>Zend_Form_Element</classname> verwendeten Standarddekoratoren sind:
  738. </para>
  739. <itemizedlist>
  740. <listitem>
  741. <para>
  742. <emphasis>ViewHelper</emphasis>: Spezifiziert einen View Helfer der verwendet
  743. wird, um das Element darzustellen. Das 'helper' Attribut des Elements kann
  744. verwendet werden, um zu spezifizieren welcher View Helfer verwendet werden soll.
  745. Standardmäßig spezifiziert <classname>Zend_Form_Element</classname> den
  746. 'formText' View Helfer, aber individuelle Unterklassen spezifizieren
  747. unterschiedliche Helfer.
  748. </para>
  749. </listitem>
  750. <listitem>
  751. <para>
  752. <emphasis>Errors</emphasis>: Fügt Fehlermeldungen an das Element an, indem es
  753. <classname>Zend_View_Helper_FormErrors</classname> verwendet. Wenn keine
  754. vorhanden sind, wird nichts hinzugefügt.
  755. </para>
  756. </listitem>
  757. <listitem>
  758. <para>
  759. <emphasis>Description</emphasis>: Fügt dem Element eine Beschreibung hinzu. Wenn
  760. keine vorhanden ist, wird nichts angehängt. Standardmäßig wird die Beschreibung
  761. in einem &lt;p&gt; Tag dargestellt mit einer CSS Klasse namens 'description'.
  762. </para>
  763. </listitem>
  764. <listitem>
  765. <para>
  766. <emphasis>HtmlTag</emphasis>: Umschliesst das Element und Fehler in einem
  767. <acronym>HTML</acronym> &lt;dd&gt; Tag.
  768. </para>
  769. </listitem>
  770. <listitem>
  771. <para>
  772. <emphasis>Label</emphasis>: Stellt ein Label vor das Element, indem es
  773. <classname>Zend_View_Helper_FormLabel</classname> verwendet, und umschliesst es
  774. in einem &lt;dt&gt; Tag. Wenn kein Label angegeben wurde, wird nur das
  775. &lt;dt&gt; Tag dargestellt.
  776. </para>
  777. </listitem>
  778. </itemizedlist>
  779. <note>
  780. <title>Standard Dekoratoren müssen nicht geladen werden</title>
  781. <para>
  782. Standardmäßig werden die Standarddekoratoren während der Initialisierung des Objekts
  783. geladen. Das kann durch die Übergabe der 'disableLoadDefaultDecorators' Option an
  784. den Konstruktor ausgeschaltet werden:
  785. </para>
  786. <programlisting language="php"><![CDATA[
  787. $element = new Zend_Form_Element('foo',
  788. array('disableLoadDefaultDecorators' =>
  789. true)
  790. );
  791. ]]></programlisting>
  792. <para>
  793. Diese Option kann mit jeder anderen Option gemischt werden die übergeben wird,
  794. sowohl als Array Option oder in einem <classname>Zend_Config</classname> Objekt.
  795. </para>
  796. </note>
  797. <para>
  798. Da die Reihenfolge, in der die Dekoratoren registriert werden, von Bedeutung ist -- der
  799. zuerst registrierte Dekorator wird als erstes ausgeführt -- muss man sicherstellen, dass
  800. eigene Dekoratoren in der richtigen Reihenfolge registriert werden, oder sicherstellen,
  801. dass die Platzierungs-Optionen in einem ausgewogenen Weg gesetzt werden. Um ein Beispiel
  802. zu geben, ist hier ein Code der den Standarddekorator registriert:
  803. </para>
  804. <programlisting language="php"><![CDATA[
  805. $this->addDecorators(array(
  806. array('ViewHelper'),
  807. array('Errors'),
  808. array('Description', array('tag' => 'p', 'class' => 'description')),
  809. array('HtmlTag', array('tag' => 'dd')),
  810. array('Label', array('tag' => 'dt')),
  811. ));
  812. ]]></programlisting>
  813. <para>
  814. Der anfängliche Inhalt wird vom 'ViewHelper' Dekorator erstellt, welche das Formular
  815. Element selbst erstellt. Als nächstes fängt der 'Errors' Dekorator Fehlermeldungen vom
  816. Element und, wenn welche vorhanden sind, übergibt er sie an den 'FormErrors' View Helfer
  817. zur Darstellung. Wenn eine Beschreibung vorhanden ist, wird der 'Description' Dekorator
  818. einen Paragraph der Klasse 'description' anhängen, der den beschreibenden Text für den
  819. betreffenden Inhalt enthält. Der nächste Dekorator, 'HtmlTag', umschliesst das Element
  820. und die Fehler in ein <acronym>HTML</acronym> &lt;dd&gt; Tag. Letztendlich, empfängt der
  821. letzte Dekorator, 'label' das Label des Elements und übergibt es an den 'FormLabel' View
  822. Helfer, und umschliesst es in einen <acronym>HTML</acronym> &lt;dt&gt; Tag; der Wert
  823. wird dem Inhalt standardmäßig vorangestellt. Die resultierende Ausgabe sieht
  824. grundsätzlich wie folgt aus:
  825. </para>
  826. <programlisting language="html"><![CDATA[
  827. <dt><label for="foo" class="optional">Foo</label></dt>
  828. <dd>
  829. <input type="text" name="foo" id="foo" value="123" />
  830. <ul class="errors">
  831. <li>"123" ist kein alphanumerischer Wert</li>
  832. </ul>
  833. <p class="description">
  834. Das ist etwas beschreibender Text betreffend dem Element.
  835. </p>
  836. </dd>
  837. ]]></programlisting>
  838. <para>
  839. Für weitere Informationen über Dekoratoren gibt es das
  840. <link linkend="zend.form.decorators">Kapitel über Zend_Form_Decorator</link>.
  841. </para>
  842. <note>
  843. <title>Mehrere Dekoratoren des gleichen Typs verwenden</title>
  844. <para>
  845. Intern verwendet <classname>Zend_Form_Element</classname> eine Dekoratorklasse als
  846. Mechanismus für das Nachschauen wenn Dekoratore empfangen werden. Als Ergebnis,
  847. können mehrere Dekratoren nicht zur gleichen Zeit registriert werden; nachgeordnete
  848. Dekoratoren überschreiben jene, die vorher existiert haben.
  849. </para>
  850. <para>
  851. Um das zu umgehen, können <emphasis>Aliase</emphasis> verwendet werden. Statt der
  852. Übergabe eines Dekorators oder Dekoratornamens als erstes Argument an
  853. <methodname>addDecorator()</methodname>, kann ein Array mit einem einzelnen Element
  854. übergeben werden, mit dem Alias der auf das Dekoratorobjekt oder -namen zeigt:
  855. </para>
  856. <programlisting language="php"><![CDATA[
  857. // Alias zu 'FooBar':
  858. $element->addDecorator(array('FooBar' => 'HtmlTag'),
  859. array('tag' => 'div'));
  860. // Und es später erhalten:
  861. $decorator = $element->getDecorator('FooBar');
  862. ]]></programlisting>
  863. <para>
  864. In den <methodname>addDecorators()</methodname> und
  865. <methodname>setDecorators()</methodname> Methoden muss die 'decorator' Option im
  866. Array übergeben werden, welche den Dekorator repräsentiert:
  867. </para>
  868. <programlisting language="php"><![CDATA[
  869. // Zwei 'HtmlTag' Dekoratore hinzufügen, einen Alias auf 'FooBar' setzen:
  870. $element->addDecorators(
  871. array('HtmlTag', array('tag' => 'div')),
  872. array(
  873. 'decorator' => array('FooBar' => 'HtmlTag'),
  874. 'options' => array('tag' => 'dd')
  875. ),
  876. );
  877. // Und sie später empfangen:
  878. $htmlTag = $element->getDecorator('HtmlTag');
  879. $fooBar = $element->getDecorator('FooBar');
  880. ]]></programlisting>
  881. </note>
  882. <para>
  883. Die folgenden Methoden sind mit Dekoratoren assoziiert:
  884. </para>
  885. <itemizedlist>
  886. <listitem>
  887. <para>
  888. <methodname>addDecorator($nameOrDecorator, array $options = null)</methodname>
  889. </para>
  890. </listitem>
  891. <listitem>
  892. <para>
  893. <methodname>addDecorators(array $decorators)</methodname>
  894. </para>
  895. </listitem>
  896. <listitem>
  897. <para>
  898. <methodname>setDecorators(array $decorators)</methodname> (Überschreibt alle
  899. Dekoratoren)
  900. </para>
  901. </listitem>
  902. <listitem>
  903. <para>
  904. <methodname>getDecorator($name)</methodname> (Empfängt ein Dekoratorobjekt durch
  905. seinen Namen)
  906. </para>
  907. </listitem>
  908. <listitem>
  909. <para>
  910. <methodname>getDecorators()</methodname> (Empfängt alle Dekoratoren)
  911. </para>
  912. </listitem>
  913. <listitem>
  914. <para>
  915. <methodname>removeDecorator($name)</methodname> (Entfernt einen Dekorator durch
  916. seinen Namen)
  917. </para>
  918. </listitem>
  919. <listitem>
  920. <para>
  921. <methodname>clearDecorators()</methodname> (Entfernt alle Dekoratoren)
  922. </para>
  923. </listitem>
  924. </itemizedlist>
  925. <para>
  926. <classname>Zend_Form_Element</classname> verwendet auch Überladung um die Darstellung
  927. von speziellen Dekoratoren zu erlauben. <methodname>__call()</methodname> interagiert
  928. mit Methoden auf mit dem Text 'render' anfangen und verwendet den Rest des
  929. Methodennamens dazu um nach einen Dekorator zu suchen; wenn er gefunden wird, wird er
  930. diesen <emphasis>einzelnen</emphasis> Dekorator darstellen. Jedes Argument das dem
  931. Methodenaufruf übergeben wird, wird als Inhalt für die Übergabe an die
  932. <methodname>render()</methodname> Methode des Dekorators verwendet. Als Beispiel:
  933. </para>
  934. <programlisting language="php"><![CDATA[
  935. // Stellt nur den ViewHelper Dekorator dar:
  936. echo $element->renderViewHelper();
  937. // Nur den HtmlTag Dekorator darstellen, und Inhalt übergeben:
  938. echo $element->renderHtmlTag("Das ist der Inhalt des HTML Tags");
  939. ]]></programlisting>
  940. <para>
  941. Wenn der Dekorator nicht existiert, wird eine Exception geworfen.
  942. </para>
  943. </sect2>
  944. <sect2 id="zend.form.elements.metadata">
  945. <title>Metadaten und Attribute</title>
  946. <para>
  947. <classname>Zend_Form_Element</classname> behandelt eine Vielzahl von Attributen und
  948. Metadaten des Elements. Basisattribute sind:
  949. </para>
  950. <itemizedlist>
  951. <listitem>
  952. <para>
  953. <emphasis>name</emphasis>: Der Name des Elements. Verwendet die Zugriffsmethoden
  954. <methodname>setName()</methodname> und <methodname>getName()</methodname>.
  955. </para>
  956. </listitem>
  957. <listitem>
  958. <para>
  959. <emphasis>label</emphasis>: Das Label des Elements. Verwendet die
  960. Zugriffsmethoden <methodname>setLabel()</methodname> und
  961. <methodname>getLabel()</methodname>.
  962. </para>
  963. </listitem>
  964. <listitem>
  965. <para>
  966. <emphasis>order</emphasis>: Der Index bei dem ein Element im Formular erscheinen
  967. soll. Verwendet die Zugriffsmethoden <methodname>setOrder()</methodname> und
  968. <methodname>getOrder()</methodname>.
  969. </para>
  970. </listitem>
  971. <listitem>
  972. <para>
  973. <emphasis>value</emphasis>: Der aktuelle Wert des Elements. Verwendet die
  974. Zugriffsmethoden <methodname>setValue()</methodname> und
  975. <methodname>getValue()</methodname>.
  976. </para>
  977. </listitem>
  978. <listitem>
  979. <para>
  980. <emphasis>description</emphasis>: Eine Beschreibung des Elements; wird oft
  981. verwendet um Tooltips oder Javascript mäßige Hinweise anzubieten die den Zweck
  982. des Elements beschreiben. Verwendet die Zugriffsmethoden
  983. <methodname>setDescription()</methodname> und
  984. <methodname>getDescription()</methodname>.
  985. </para>
  986. </listitem>
  987. <listitem>
  988. <para>
  989. <emphasis>required</emphasis>: Ein Flag, das anzeigt ob ein Element benötigt
  990. wird wenn eine Prüfung des Formulars durchgeführt wird, oder nicht. Verwendet
  991. die Zugriffsmethoden <methodname>setRequired()</methodname> und
  992. <methodname>isRequired()</methodname>. Dieses Flag ist standardmäßig
  993. <constant>FALSE</constant>.
  994. </para>
  995. </listitem>
  996. <listitem>
  997. <para>
  998. <emphasis>allowEmpty</emphasis>: Ein Flag, das indiziert ob ein nicht benötigtes
  999. (optionales) Element versuchen soll leere Werte zu prüfen. Wenn es
  1000. <constant>TRUE</constant> ist, und das 'required' Flag
  1001. <constant>FALSE</constant>, dann werden leere Werte nicht an die Prüfkette
  1002. übergeben, und es wird <constant>TRUE</constant> angenommen. Verwendet die
  1003. Zugriffsmethoden <methodname>setAllowEmpty()</methodname> und
  1004. <methodname>getAllowEmpty()</methodname>. Dieses Flag ist standardmäßig
  1005. <constant>TRUE</constant>.
  1006. </para>
  1007. </listitem>
  1008. <listitem>
  1009. <para>
  1010. <emphasis>autoInsertNotEmptyValidator</emphasis>: Ein Flag, das indiziert, ob
  1011. eine 'NotEmpty' Prüfung eingefügt werden soll, wenn das Element benötigt wird,
  1012. oder nicht. Standardmäßig ist dieses Flag <constant>TRUE</constant>. Das Flag
  1013. kann mit <methodname>setAutoInsertNotEmptyValidator($flag)</methodname> gesetzt
  1014. und der Wert mit <methodname>autoInsertNotEmptyValidator()</methodname>
  1015. ermittelt werden.
  1016. </para>
  1017. </listitem>
  1018. </itemizedlist>
  1019. <para>
  1020. Formular Elemente können zusätzliche Metadaten benötigen. Für <acronym>XHTML</acronym>
  1021. Form Elemente zum Beispiel, kann es gewünscht sein, Attribute wie die Klasse oder die Id
  1022. zu spezifizieren. Für die Durchführung gibt es ein Set von Zugriffsmethoden:
  1023. </para>
  1024. <itemizedlist>
  1025. <listitem>
  1026. <para>
  1027. <emphasis>setAttrib($name, $value)</emphasis>: Fügt ein Attribut hinzu
  1028. </para>
  1029. </listitem>
  1030. <listitem>
  1031. <para>
  1032. <emphasis>setAttribs(array $attribs)</emphasis>: Wie addAttribs(), aber
  1033. überschreibend
  1034. </para>
  1035. </listitem>
  1036. <listitem>
  1037. <para>
  1038. <emphasis>getAttrib($name)</emphasis>: Empfägt einen einzelnen Attributwert
  1039. </para>
  1040. </listitem>
  1041. <listitem>
  1042. <para>
  1043. <emphasis>getAttribs()</emphasis>: Empfängt alle Attribute als Schlüssel/Wert
  1044. Paare
  1045. </para>
  1046. </listitem>
  1047. </itemizedlist>
  1048. <para>
  1049. Die meiste Zeit kann auf sie, trotzdem, einfach als Objekteigenschaften zugegriffen
  1050. werden, da <classname>Zend_Form_Element</classname> das Überladen realisiert und den
  1051. Zugriff zu ihnen erlaubt:
  1052. </para>
  1053. <programlisting language="php"><![CDATA[
  1054. // Gleichbedeutend mit $element->setAttrib('class', 'text'):
  1055. $element->class = 'text;
  1056. ]]></programlisting>
  1057. <para>
  1058. Standardmäßig werden alle Attribute, die an den View Helfer übergeben werden, auch vom
  1059. Element während der Darstellung verwendet, und als <acronym>HTML</acronym> Attribute des
  1060. Element Tags dargestellt.
  1061. </para>
  1062. </sect2>
  1063. <sect2 id="zend.form.elements.standard">
  1064. <title>Standard Elemente</title>
  1065. <para>
  1066. <classname>Zend_Form</classname> wird mit einer Anzahl an Standardelementen
  1067. ausgeliefert; lesen Sie das Kapitel über
  1068. <link linkend="zend.form.standardElements">Standard Elemente</link> für vollständige
  1069. Details.
  1070. </para>
  1071. </sect2>
  1072. <sect2 id="zend.form.elements.methods">
  1073. <title>Zend_Form_Element Methoden</title>
  1074. <para>
  1075. <classname>Zend_Form_Element</classname> hat viele, viele Methoden. Was folgt, ist eine
  1076. kurze Zusammenfassung ihrer Signatur - gruppiert nach Typ:
  1077. </para>
  1078. <itemizedlist>
  1079. <listitem>
  1080. <para>Konfiguration:</para>
  1081. <itemizedlist>
  1082. <listitem>
  1083. <para><methodname>setOptions(array $options)</methodname></para>
  1084. </listitem>
  1085. <listitem>
  1086. <para><methodname>setConfig(Zend_Config $config)</methodname></para>
  1087. </listitem>
  1088. </itemizedlist>
  1089. </listitem>
  1090. <listitem>
  1091. <para>I18n:</para>
  1092. <itemizedlist>
  1093. <listitem>
  1094. <para>
  1095. <methodname>setTranslator(Zend_Translate_Adapter $translator =
  1096. null)</methodname>
  1097. </para>
  1098. </listitem>
  1099. <listitem><para><methodname>getTranslator()</methodname></para></listitem>
  1100. <listitem>
  1101. <para><methodname>setDisableTranslator($flag)</methodname></para>
  1102. </listitem>
  1103. <listitem>
  1104. <para><methodname>translatorIsDisabled()</methodname></para>
  1105. </listitem>
  1106. </itemizedlist>
  1107. </listitem>
  1108. <listitem>
  1109. <para>Eigenschaften:</para>
  1110. <itemizedlist>
  1111. <listitem><para><methodname>setName($name)</methodname></para></listitem>
  1112. <listitem><para><methodname>getName()</methodname></para></listitem>
  1113. <listitem><para><methodname>setValue($value)</methodname></para></listitem>
  1114. <listitem><para><methodname>getValue()</methodname></para></listitem>
  1115. <listitem><para><methodname>getUnfilteredValue()</methodname></para></listitem>
  1116. <listitem><para><methodname>setLabel($label)</methodname></para></listitem>
  1117. <listitem><para><methodname>getLabel()</methodname></para></listitem>
  1118. <listitem>
  1119. <para><methodname>setDescription($description)</methodname></para>
  1120. </listitem>
  1121. <listitem><para><methodname>getDescription()</methodname></para></listitem>
  1122. <listitem><para><methodname>setOrder($order)</methodname></para></listitem>
  1123. <listitem><para><methodname>getOrder()</methodname></para></listitem>
  1124. <listitem><para><methodname>setRequired($flag)</methodname></para></listitem>
  1125. <listitem><para><methodname>isRequired()</methodname></para></listitem>
  1126. <listitem><para><methodname>setAllowEmpty($flag)</methodname></para></listitem>
  1127. <listitem><para><methodname>getAllowEmpty()</methodname></para></listitem>
  1128. <listitem>
  1129. <para>
  1130. <methodname>setAutoInsertNotEmptyValidator($flag)</methodname>
  1131. </para>
  1132. </listitem>
  1133. <listitem>
  1134. <para><methodname>autoInsertNotEmptyValidator()</methodname></para>
  1135. </listitem>
  1136. <listitem><para><methodname>setIgnore($flag)</methodname></para></listitem>
  1137. <listitem><para><methodname>getIgnore()</methodname></para></listitem>
  1138. <listitem><para><methodname>getType()</methodname></para></listitem>
  1139. <listitem>
  1140. <para><methodname>setAttrib($name, $value)</methodname></para>
  1141. </listitem>
  1142. <listitem>
  1143. <para><methodname>setAttribs(array $attribs)</methodname></para>
  1144. </listitem>
  1145. <listitem><para><methodname>getAttrib($name)</methodname></para></listitem>
  1146. <listitem><para><methodname>getAttribs()</methodname></para></listitem>
  1147. </itemizedlist>
  1148. </listitem>
  1149. <listitem>
  1150. <para>Plugin Loader und Pfade:</para>
  1151. <itemizedlist>
  1152. <listitem>
  1153. <para>
  1154. <methodname>setPluginLoader(Zend_Loader_PluginLoader_Interface $loader,
  1155. $type)</methodname>
  1156. </para>
  1157. </listitem>
  1158. <listitem>
  1159. <para><methodname>getPluginLoader($type)</methodname></para>
  1160. </listitem>
  1161. <listitem>
  1162. <para>
  1163. <methodname>addPrefixPath($prefix, $path, $type = null)</methodname>
  1164. </para>
  1165. </listitem>
  1166. <listitem>
  1167. <para><methodname>addPrefixPaths(array $spec)</methodname></para>
  1168. </listitem>
  1169. </itemizedlist>
  1170. </listitem>
  1171. <listitem>
  1172. <para>Prüfung:</para>
  1173. <itemizedlist>
  1174. <listitem>
  1175. <para>
  1176. <methodname>addValidator($validator, $breakChainOnFailure = false,
  1177. $options = array())</methodname>
  1178. </para>
  1179. </listitem>
  1180. <listitem>
  1181. <para><methodname>addValidators(array $validators)</methodname></para>
  1182. </listitem>
  1183. <listitem>
  1184. <para><methodname>setValidators(array $validators)</methodname></para>
  1185. </listitem>
  1186. <listitem><para><methodname>getValidator($name)</methodname></para></listitem>
  1187. <listitem><para><methodname>getValidators()</methodname></para></listitem>
  1188. <listitem>
  1189. <para><methodname>removeValidator($name)</methodname></para>
  1190. </listitem>
  1191. <listitem><para><methodname>clearValidators()</methodname></para></listitem>
  1192. <listitem>
  1193. <para><methodname>isValid($value, $context = null)</methodname></para>
  1194. </listitem>
  1195. <listitem><para><methodname>getErrors()</methodname></para></listitem>
  1196. <listitem><para><methodname>getMessages()</methodname></para></listitem>
  1197. </itemizedlist>
  1198. </listitem>
  1199. <listitem>
  1200. <para>Filter:</para>
  1201. <itemizedlist>
  1202. <listitem>
  1203. <para>
  1204. <methodname>addFilter($filter, $options = array())</methodname>
  1205. </para>
  1206. </listitem>
  1207. <listitem>
  1208. <para><methodname>addFilters(array $filters)</methodname></para>
  1209. </listitem>
  1210. <listitem>
  1211. <para><methodname>setFilters(array $filters)</methodname></para>
  1212. </listitem>
  1213. <listitem><para><methodname>getFilter($name)</methodname></para></listitem>
  1214. <listitem><para><methodname>getFilters()</methodname></para></listitem>
  1215. <listitem><para><methodname>removeFilter($name)</methodname></para></listitem>
  1216. <listitem><para><methodname>clearFilters()</methodname></para></listitem>
  1217. </itemizedlist>
  1218. </listitem>
  1219. <listitem>
  1220. <para>Darstellung:</para>
  1221. <itemizedlist>
  1222. <listitem>
  1223. <para>
  1224. <methodname>setView(Zend_View_Interface $view = null)</methodname>
  1225. </para>
  1226. </listitem>
  1227. <listitem><para><methodname>getView()</methodname></para></listitem>
  1228. <listitem>
  1229. <para>
  1230. <methodname>addDecorator($decorator, $options = null)</methodname>
  1231. </para>
  1232. </listitem>
  1233. <listitem>
  1234. <para><methodname>addDecorators(array $decorators)</methodname></para>
  1235. </listitem>
  1236. <listitem>
  1237. <para><methodname>setDecorators(array $decorators)</methodname></para>
  1238. </listitem>
  1239. <listitem><para><methodname>getDecorator($name)</methodname></para></listitem>
  1240. <listitem><para><methodname>getDecorators()</methodname></para></listitem>
  1241. <listitem>
  1242. <para><methodname>removeDecorator($name)</methodname></para>
  1243. </listitem>
  1244. <listitem><para><methodname>clearDecorators()</methodname></para></listitem>
  1245. <listitem>
  1246. <para>
  1247. <methodname>render(Zend_View_Interface $view = null)</methodname>
  1248. </para>
  1249. </listitem>
  1250. </itemizedlist>
  1251. </listitem>
  1252. </itemizedlist>
  1253. </sect2>
  1254. <sect2 id="zend.form.elements.config">
  1255. <title>Konfiguration</title>
  1256. <para>
  1257. Der Konstruktor von <classname>Zend_Form_Element</classname> akzeptiert entweder einen
  1258. Array von Optionen oder ein <classname>Zend_Config</classname> Objekt das Optionen
  1259. enthält, und es kann auch durch Verwendung von <methodname>setOptions()</methodname>
  1260. oder <methodname>setConfig()</methodname> konfiguriert werden. Generell, werden die
  1261. Schlüssel wie folgt benannt:
  1262. </para>
  1263. <itemizedlist>
  1264. <listitem>
  1265. <para>
  1266. Wenn 'set' + Schlüssel auf eine <classname>Zend_Form_Element</classname> Methode
  1267. zeigt, dann wird der angebotene Wert zu dieser Methode übermittelt.
  1268. </para>
  1269. </listitem>
  1270. <listitem>
  1271. <para>Andernfalls wird der Wert verwendet um ein Attribut zu setzen.</para>
  1272. </listitem>
  1273. </itemizedlist>
  1274. <para>
  1275. Ausnahmen zu dieser Regel sind die folgenden:
  1276. </para>
  1277. <itemizedlist>
  1278. <listitem>
  1279. <para>
  1280. <property>prefixPath</property> wird an
  1281. <methodname>addPrefixPaths()</methodname> übergeben
  1282. </para>
  1283. </listitem>
  1284. <listitem>
  1285. <para>
  1286. Die folgenden Setzer können nicht auf diesem Weg gesetzt werden:
  1287. </para>
  1288. <itemizedlist>
  1289. <listitem>
  1290. <para>
  1291. <property>setAttrib</property> (über <property>setAttribs</property>
  1292. <emphasis>wird</emphasis> es funktionieren)
  1293. </para>
  1294. </listitem>
  1295. <listitem><para><property>setConfig</property></para></listitem>
  1296. <listitem><para><property>setOptions</property></para></listitem>
  1297. <listitem><para><property>setPluginLoader</property></para></listitem>
  1298. <listitem><para><property>setTranslator</property></para></listitem>
  1299. <listitem><para><property>setView</property></para></listitem>
  1300. </itemizedlist>
  1301. </listitem>
  1302. </itemizedlist>
  1303. <para>
  1304. Als Beispiel ist hier eine Konfigurationsdatei die eine Konfiguration für jeden
  1305. Typ von konfigurierbaren Daten übergibt:
  1306. </para>
  1307. <programlisting language="ini"><![CDATA[
  1308. [element]
  1309. name = "foo"
  1310. value = "foobar"
  1311. label = "Foo:"
  1312. order = 10
  1313. required = true
  1314. allowEmpty = false
  1315. autoInsertNotEmptyValidator = true
  1316. description = "Foo Elemente sind für Beispiele"
  1317. ignore = false
  1318. attribs.id = "foo"
  1319. attribs.class = "element"
  1320. ; Setzt das 'onclick' Attribut
  1321. onclick = "autoComplete(this, '/form/autocomplete/element')"
  1322. prefixPaths.decorator.prefix = "My_Decorator"
  1323. prefixPaths.decorator.path = "My/Decorator/"
  1324. disableTranslator = 0
  1325. validators.required.validator = "NotEmpty"
  1326. validators.required.breakChainOnFailure = true
  1327. validators.alpha.validator = "alpha"
  1328. validators.regex.validator = "regex"
  1329. validators.regex.options.pattern = "/^[A-F].*/$"
  1330. filters.ucase.filter = "StringToUpper"
  1331. decorators.element.decorator = "ViewHelper"
  1332. decorators.element.options.helper = "FormText"
  1333. decorators.label.decorator = "Label"
  1334. ]]></programlisting>
  1335. </sect2>
  1336. <sect2 id="zend.form.elements.custom">
  1337. <title>Eigene Elemente</title>
  1338. <para>
  1339. Es können eigene Elemente durch die Erweiterung der
  1340. <classname>Zend_Form_Element</classname> Klasse erstellt werden. Übliche Gründe hierfür
  1341. sind:
  1342. </para>
  1343. <itemizedlist>
  1344. <listitem>
  1345. <para>Elemente, die eine gemeinsame Prüfung und/oder Filter teilen</para>
  1346. </listitem>
  1347. <listitem>
  1348. <para>Elemente die eine eigene Dekoratoren Funktionalität haben</para>
  1349. </listitem>
  1350. </itemizedlist>
  1351. <para>
  1352. Es gibt zwei Methoden die typischerweise verwendet werden, um ein Element zu erweitern:
  1353. <methodname>init()</methodname>, was verwendet werden kannm um eine eigene
  1354. Initialisierungs-Logik zum Element hinzuzufügen, und
  1355. <methodname>loadDefaultDecorators()</methodname>, was verwendet werden kann um eine
  1356. Liste von Standard Dekoratoren zu setzen, die vom Element verwendet werden sollen.
  1357. </para>
  1358. <para>
  1359. Als Beispiel nehmen wir an, dass alle Text Elemente eines Formulars die erstellt werden
  1360. mit <classname>StringTrim</classname> gefiltert werden müssen, mit einem gemeinsamen
  1361. Regulären Ausdruck und das ein eigener Dekorator 'My_Decorator_TextItem' verwendet
  1362. werden soll, der für die Darstellung von ihnen erstellt wurde; zusätzlich gibt es eine
  1363. Anzahl an Standardattributen, wie 'size', 'maxLength', und 'class', die spezifiziert
  1364. werden sollen. So ein Element könnte wie folgt definiert werden:
  1365. </para>
  1366. <programlisting language="php"><![CDATA[
  1367. class My_Element_Text extends Zend_Form_Element
  1368. {
  1369. public function init()
  1370. {
  1371. $this->addPrefixPath('My_Decorator', 'My/Decorator/', 'decorator')
  1372. ->addFilters('StringTrim')
  1373. ->addValidator('Regex', false, array('/^[a-z0-9]{6,}$/i'))
  1374. ->addDecorator('TextItem')
  1375. ->setAttrib('size', 30)
  1376. ->setAttrib('maxLength', 45)
  1377. ->setAttrib('class', 'text');
  1378. }
  1379. }
  1380. ]]></programlisting>
  1381. <para>
  1382. Man könnte dann das Formular Objekt über den Präfix Pfad für diese Elemente informieren,
  1383. und die Erstellung der Elemente beginnen:
  1384. </para>
  1385. <programlisting language="php"><![CDATA[
  1386. $form->addPrefixPath('My_Element', 'My/Element/', 'element')
  1387. ->addElement('text', 'foo');
  1388. ]]></programlisting>
  1389. <para>
  1390. Das 'foo' Element wird vom Typ <classname>My_Element_Text</classname> sein, und dem
  1391. beschriebenen Verhalten entsprechen.
  1392. </para>
  1393. <para>
  1394. Eine andere Methode, die man überschreiben sollte, wenn
  1395. <classname>Zend_Form_Element</classname> erweitert wird, ist die
  1396. <methodname>loadDefaultDecorators()</methodname> Methode. Diese Methode lädt fallweise
  1397. ein Set von Standarddekoratoren für das Element; es kann gewünscht sein, eigene
  1398. Dekoratoren in der erweiterten Klasse zu verwenden:
  1399. </para>
  1400. <programlisting language="php"><![CDATA[
  1401. class My_Element_Text extends Zend_Form_Element
  1402. {
  1403. public function loadDefaultDecorators()
  1404. {
  1405. $this->addDecorator('ViewHelper')
  1406. ->addDecorator('DisplayError')
  1407. ->addDecorator('Label')
  1408. ->addDecorator('HtmlTag',
  1409. array('tag' => 'div', 'class' => 'element'));
  1410. }
  1411. }
  1412. ]]></programlisting>
  1413. <para>
  1414. Es gibt viele Wege, Elemente anzupassen; man sollte sicherstellen die
  1415. <acronym>API</acronym> Dokumentation von <classname>Zend_Form_Element</classname> zu
  1416. lesen um alle vorhandenen Methoden zu kennen.
  1417. </para>
  1418. </sect2>
  1419. </sect1>