Zend_View-Helpers.xml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20799 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.view.helpers" xmlns:xi="http://www.w3.org/2001/XInclude">
  5. <title>View Helfer</title>
  6. <para>
  7. In deinen View Skripten ist es oft notwendig, bestimmte komplexe Funktionen immer wieder
  8. auszuführen, z.B. Datum formatieren, Formularelemente erstellen oder Links für Aktionen
  9. anzuzeigen. Du kannst Helferklassen verwenden, um diese Aufgaben für dich durchführen zu
  10. lassen.
  11. </para>
  12. <para>
  13. Ein Helfer ist einfach eine Klasse. Nehmen wir an wir wollen einen Helfer der 'fooBar'
  14. heißt. Standardmäßig wird der Klasse 'Zend_View_Helper_' vorangestellt (Es kann ein
  15. eigener Prefix definiert werden wenn ein Pfad für die Helfer definiert wird), und das letzte
  16. Segment des Klassennamens ist der Name des Helfers; Dieses Segment sollte Titel
  17. Großgeschrieben sein; der volle Klassenname ist dann:
  18. <classname>Zend_View_Helper_FooBar</classname>. Diese Klasse sollte mindestens eine einzelne
  19. Methode enthalten, die nach dem Helfer benannt und camelCased ist:
  20. <methodname>fooBar()</methodname>.
  21. </para>
  22. <note>
  23. <title>Betrachte den Fall</title>
  24. <para>
  25. Namen von Helfern sind immer camelCased, bzw. beginnen Sie nie mit einem
  26. großgeschriebenen Zeichen. Der Klassenname selbst ist MixedCased, aber die Methode die
  27. aktuell ausgeführt wird ist camelCased.
  28. </para>
  29. </note>
  30. <note>
  31. <title>Standard Helfer Pfad</title>
  32. <para>
  33. Der Standard Helfer Pfad zeigt immer zu den View Helfern des Zend Frameworks,
  34. normalerweise 'Zend/View/Helper/'. Selbst wenn <methodname>setHelperPath()</methodname>
  35. ausgerufen wird um den existierenden Pfad zu überschreiben, wird dieser Pfad gesetzt um
  36. sicherzustellen das die Standard Helfer arbeiten.
  37. </para>
  38. </note>
  39. <para>
  40. Um einen Helfer in deinem View Skript zu verwenden, rufe ihn mittels
  41. <command>$this->helperName()</command> auf. Im Hintergrund wird
  42. <classname>Zend_View</classname> die Klasse
  43. <classname>Zend_View_Helper_HelperName</classname> laden, eine Objektinstanz der
  44. Klasse erstellen und deren Methode <methodname>helperName()</methodname> aufrufen. Die
  45. Objektinstanz bleibt innerhalb der <classname>Zend_View</classname> Instanz bestehen und
  46. wird bei allen weiteren Aufrufen von <command>$this->helperName()</command> wiederverwendet.
  47. </para>
  48. <sect2 id="zend.view.helpers.initial">
  49. <title>Vorhandene Helfer</title>
  50. <para>
  51. <classname>Zend_View</classname> enthält bereits einige vorhandene Helferklassen, die
  52. sich alle auf die Erstellung von Formularelementen beziehen und die notwendige
  53. Maskierung der Ausgaben automatisch vornehmen. Zusätzlich gibt es Helfer zum Erstellen
  54. Routen-basierter <acronym>URL</acronym>S and HTML Listen, genauso wie für das
  55. Deklarieren von Variablen. Die aktuell gelieferten Helfer beinhalten:
  56. </para>
  57. <itemizedlist>
  58. <listitem>
  59. <para>
  60. <methodname>declareVars()</methodname>: Primär benutzt mit
  61. <methodname>strictVars()</methodname>, kann dieser Helfer verwendet werden um
  62. template Variablen zu deklarieren welche bereits, oder noch nicht, im View
  63. Objekt bereits gesetzt sind, sowie auch Standard Werte. Arrays welche als
  64. Argument dieser Methode übergeben werden, werden verwendet um Standard Werte zu
  65. setzen; Andernfalls, wenn die Variable nicht existiert, wird diese mit einem
  66. leeren String gesetzt.
  67. </para>
  68. </listitem>
  69. <listitem>
  70. <para>
  71. <methodname>fieldset($name, $content, $attribs)</methodname>: Erstellt ein
  72. <acronym>XHTML</acronym> Fieldset. Wenn <varname>$attribs</varname> einen
  73. 'legend' Schlüssel enthält, wird der Wert für die Fieldset Beschriftung
  74. verwendet. Das Fieldset wird <varname>$content</varname> umfassen wie vom Helfer
  75. angeboten.
  76. </para>
  77. </listitem>
  78. <listitem>
  79. <para>
  80. <methodname>form($name, $attribs, $content)</methodname>: Erzeugt eine
  81. <acronym>XHTML</acronym> Form. Alle <varname>$attribs</varname> werden als
  82. <acronym>XHTML</acronym> Attribute des Form Tags escaped und dargestellt. Wenn
  83. <varname>$content</varname> vorhanden und kein boolsches
  84. <constant>FALSE</constant> ist, dann wird dieser Inhalt innerhalb der Start und
  85. End Form Tags dargestellt werden; wenn <varname>$content</varname> ein boolsches
  86. <constant>FALSE</constant> ist (der Standard), wird nur das beginnende Formtag
  87. erzeugt.
  88. </para>
  89. </listitem>
  90. <listitem>
  91. <para>
  92. <methodname>formButton($name, $value, $attribs)</methodname>: Erstellt ein
  93. &lt;button /&gt; Element.
  94. </para>
  95. </listitem>
  96. <listitem>
  97. <para>
  98. <methodname>formCheckbox($name, $value, $attribs, $options)</methodname>:
  99. Erstellt ein &lt;input type="checkbox" /&gt; Element.
  100. </para>
  101. <para>
  102. Standardmäßig, wenn kein $value angegeben und keine $options vorhanden sind,
  103. wird '0' als ungecheckter Wert, und '1' als gecheckter Wert angenommen. Wenn
  104. ein $value übergeben wird, aber keine $options vorhanden sind, wird der
  105. gecheckte Wert and der übergebene Wert angenommen.
  106. </para>
  107. <para>
  108. $options sollte ein Array sein. Wenn das Array indiziert ist, ist der erste
  109. Wert der gecheckte Wert, und der zweite der ungecheckte Wert; alle anderen
  110. Werte werden ignoriert. Es kann auch ein assoziatives Array mit den Schlüsseln
  111. 'checked' und 'unChecked' übergeben werden.
  112. </para>
  113. <para>
  114. Wenn $options übergeben wurden und $value mit dem gecheckten Wert
  115. übereinstimmt, dann wird das Element als gecheckt markiert. Das Element kann
  116. auch als gecheckt oder ungecheckt markiert werden indem ein boolscher Wert
  117. für das Attribut 'checked' übergeben wird.
  118. </para>
  119. <para>
  120. Das obige wird möglicherweise am besten mit einigen Beispielen zusammengefasst:
  121. </para>
  122. <programlisting language="php"><![CDATA[
  123. // '1' und '0' als gecheckte/ungecheckte Optionen; nicht gecheckt
  124. echo $this->formCheckbox('foo');
  125. // '1' und '0' als gecheckte/ungecheckte Optionen; gecheckt
  126. echo $this->formCheckbox('foo', null, array('checked' => true));
  127. // 'bar' und '0' als gecheckte/ungecheckte Optionen; nicht gecheckt
  128. echo $this->formCheckbox('foo', 'bar');
  129. // 'bar' und '0' als gecheckte/ungecheckte Optionen; gecheckt
  130. echo $this->formCheckbox('foo', 'bar', array('checked' => true));
  131. // 'bar' und 'baz' als gecheckte/ungecheckte Optionen; nicht gecheckt
  132. echo $this->formCheckbox('foo', null, null, array('bar', 'baz'));
  133. // 'bar' und 'baz' als gecheckte/ungecheckte Optionen; nicht gecheckt
  134. echo $this->formCheckbox('foo', null, null, array(
  135. 'checked' => 'bar',
  136. 'unChecked' => 'baz'
  137. ));
  138. // 'bar' und 'baz' als gecheckte/ungecheckte Optionen; gecheckt
  139. echo $this->formCheckbox('foo', 'bar', null, array('bar', 'baz'));
  140. echo $this->formCheckbox('foo',
  141. null,
  142. array('checked' => true),
  143. array('bar', 'baz'));
  144. // 'bar' und 'baz' als gecheckte/ungecheckte Optionen; nicht gecheckt
  145. echo $this->formCheckbox('foo', 'baz', null, array('bar', 'baz'));
  146. echo $this->formCheckbox('foo',
  147. null,
  148. array('checked' => false),
  149. array('bar', 'baz'));
  150. ]]></programlisting>
  151. <para>
  152. In allen Fällen, wird das Markup einem versteckten Element mit dem
  153. nicht gecheckten Wert vorangestellt; auf diesem Weg erhält man
  154. trotzdem einen gültigen Wert von der Form selbst wenn der Wert nicht
  155. gecheckt wird.
  156. </para>
  157. </listitem>
  158. <listitem>
  159. <para>
  160. <methodname>formErrors($errors, $options)</methodname>: Erzeugt eine ungeordnete
  161. <acronym>XHTML</acronym> Liste und zeigt Fehler an. <varname>$errors</varname>
  162. sollte ein String oder ein Array von Strings sein; <varname>$options</varname>
  163. sollte irgendein Attribut sein das im beginnenden List Tag platziert werden
  164. soll.
  165. </para>
  166. <para>
  167. Es kann alternativer beginnender, schließender und seperierter Inhalt
  168. spezifiziert werden wenn Fehler dargestellt werden durch aufruf von
  169. verschiedenen Methoden auf dem Helfer:
  170. </para>
  171. <itemizedlist>
  172. <listitem>
  173. <para>
  174. <methodname>setElementStart($string)</methodname>; Standard ist
  175. '&lt;ul class="errors"%s"&gt;&lt;li&gt;', wobei %s mit den in
  176. <varname>$options</varname> spezifizierten Attributen ersetzt wird.
  177. </para>
  178. </listitem>
  179. <listitem>
  180. <para>
  181. <methodname>setElementSeparator($string)</methodname>; Standard ist
  182. '&lt;/li&gt;&lt;li&gt;'.
  183. </para>
  184. </listitem>
  185. <listitem>
  186. <para>
  187. <methodname>setElementEnd($string)</methodname>; Standard ist
  188. '&lt;/li&gt;&lt;/ul&gt;'.
  189. </para>
  190. </listitem>
  191. </itemizedlist>
  192. </listitem>
  193. <listitem>
  194. <para>
  195. <methodname>formFile($name, $attribs)</methodname>: Erstellt ein
  196. &lt;input type="file" /&gt; Element.
  197. </para>
  198. </listitem>
  199. <listitem>
  200. <para>
  201. <methodname>formHidden($name, $value, $attribs)</methodname>: Erstellt ein
  202. &lt;input type="hidden" /&gt; Element.
  203. </para>
  204. </listitem>
  205. <listitem>
  206. <para>
  207. <methodname>formLabel($name, $value, $attribs)</methodname>: Erstellt ein
  208. &lt;label&gt; Element, setzt das <property>for</property> Attribut auf
  209. <varname>$name</varname>, und den aktuellen Labeltext auf
  210. <varname>$value</varname>. Wenn <emphasis>disable</emphasis> an
  211. <property>attribs</property> übergeben wird, wird nichts zurückgegeben.
  212. </para>
  213. </listitem>
  214. <listitem>
  215. <para>
  216. <methodname>formMultiCheckbox($name, $value, $attribs, $options,
  217. $listsep)</methodname>: Erstellt eine Liste von Checkboxen.
  218. <varname>$options</varname> sollte ein assoziatives Array sein und kann beliebig
  219. tief werden. <varname>$value</varname> kann ein einzelner Wert oder ein Array
  220. von ausgewählten Werten sein die Schlüsseln im <varname>$options</varname> Array
  221. entsprechen. <varname>$listsep</varname> ist standardmäßig ein HTML Break
  222. ("&lt;br /&gt;"). Standardmäßig wird dieses Element als Array behandelt; alle
  223. Checkboxen teilen den gleichen Namen, und werden als Array übertragen.
  224. </para>
  225. </listitem>
  226. <listitem>
  227. <para>
  228. <methodname>formPassword($name, $value, $attribs)</methodname>: Erstellt ein
  229. &lt;input type="password" /&gt; Element.
  230. </para>
  231. </listitem>
  232. <listitem>
  233. <para>
  234. <methodname>formRadio($name, $value, $attribs, $options)</methodname>: Erstellt
  235. eine Reihe von &lt;input type="radio" /&gt; Elementen, eine für jeden der
  236. $options Elemente. Im $options Array ist der Elementschlüssel der Wert und der
  237. Elementwert die Bezeichnung des Radio-Buttons. Der $value Radiobutton wird für
  238. dich vorgewählt.
  239. </para>
  240. </listitem>
  241. <listitem>
  242. <para>
  243. <methodname>formReset($name, $value, $attribs)</methodname>: Erstellt ein
  244. &lt;input type="reset" /&gt; Element.
  245. </para>
  246. </listitem>
  247. <listitem>
  248. <para>
  249. <methodname>formSelect($name, $value, $attribs, $options)</methodname>: Erstellt
  250. einen &lt;select&gt;...&lt;/select&gt; block mit einer &lt;option&gt;one für
  251. jedes $options Element. Im $options Array ist der Elementschlüssel der
  252. Optionswert und der Elementwert die Optionsbezeichnung. Die $value Optionen
  253. werden für dich vorgewählt.
  254. </para>
  255. </listitem>
  256. <listitem>
  257. <para>
  258. <methodname>formSubmit($name, $value, $attribs)</methodname>: Erstellt ein
  259. &lt;input type="submit" /&gt; Element.
  260. </para>
  261. </listitem>
  262. <listitem>
  263. <para>
  264. <methodname>formText($name, $value, $attribs)</methodname>: Erstellt ein
  265. &lt;input type="text" /&gt; Element.
  266. </para>
  267. </listitem>
  268. <listitem>
  269. <para>
  270. <methodname>formTextarea($name, $value, $attribs)</methodname>: Erstellt einen
  271. &lt;textarea&gt;...&lt;/textarea&gt; Block.
  272. </para>
  273. </listitem>
  274. <listitem>
  275. <para>
  276. <methodname>url($urlOptions, $name, $reset)</methodname>: Erstellt einen
  277. <acronym>URL</acronym> String basierend auf dem Namen der Route.
  278. <varname>$urlOptions</varname> sollte ein assoziatives Array von Schlüßel/Werte
  279. Paaren sein, welche bon der speziellen Route verwendet wird.
  280. </para>
  281. </listitem>
  282. <listitem>
  283. <para>
  284. <methodname>htmlList($items, $ordered, $attribs, $escape)</methodname>: erzeugt
  285. ungeordnete und geordnete Listen welche auf den <varname>$items</varname>
  286. basieren die übergeben wurden. Wenn <varname>$items</varname> ein
  287. multidimensionales Array ist, wird eine verschachtelte Liste gebaut. Wenn das
  288. <varname>$escape</varname> Flag <constant>TRUE</constant> ist (standard), werden
  289. individuelle Abschnitte escaped durch Verwendung des Escaping Mechanismus der im
  290. View Objekt registriert wurde; ein <constant>FALSE</constant> Wert wird
  291. übergeben wenn Markups in den Listen gewünscht werden.
  292. </para>
  293. </listitem>
  294. </itemizedlist>
  295. <para>
  296. Die Verwendung dieser Helfer in deinem View Skript ist sehr einfach, hier ist ein
  297. Beispiel. Beachte, dass du diese Helfer nur aufzurufen brauchst; sie werden automatisch
  298. geladen und instanziiert, sobald sie benötigt werden.
  299. </para>
  300. <programlisting language="php"><![CDATA[
  301. // Innerhalb deines View Skriptes, verweist $this auf die Zend_View
  302. // Instanz.
  303. //
  304. // Sagen wir, dass du bereits eine Serie von Auswahlwerten der Variable
  305. // $countries in Form eines Arrays zugewiesen hast
  306. // ('us' => 'United States', 'il' => 'Israel', 'de' => 'Germany')
  307. ?>
  308. <form action="action.php" method="post">
  309. <p><label>Deine Email:
  310. <?php echo $this->formText('email', 'you@example.com', array('size' => 32)) ?>
  311. </label></p>
  312. <p><label>Dein Land:
  313. <?php echo $this->formSelect('country', 'us', null, $this->countries) ?>
  314. </label></p>
  315. <p><label>Möchtest Du hinzugefügt werden?
  316. <?php echo $this->formCheckbox('opt_in', 'yes', null, array('yes', 'no')) ?>
  317. </label></p>
  318. </form>
  319. ]]></programlisting>
  320. <para>
  321. Die Ausgabe des View Skriptes wird in etwa so aussehen:
  322. </para>
  323. <programlisting language="php"><![CDATA[
  324. <form action="action.php" method="post">
  325. <p><label>Deine Email:
  326. <input type="text" name="email" value="you@example.com" size="32" />
  327. </label></p>
  328. <p><label>Dein Land:
  329. <select name="country">
  330. <option value="us" selected="selected">Amerika</option>
  331. <option value="il">Israel</option>
  332. <option value="de">Deutschland</option>
  333. </select>
  334. </label></p>
  335. <p><label>Möchtest Du hinzugefügt werden?
  336. <input type="hidden" name="opt_in" value="no" />
  337. <input type="checkbox" name="opt_in" value="yes" checked="checked" />
  338. </label></p>
  339. </form>
  340. ]]></programlisting>
  341. <xi:include href="Zend_View-Helpers-Action.xml" />
  342. <xi:include href="Zend_View-Helpers-BaseUrl.xml" />
  343. <xi:include href="Zend_View-Helpers-Currency.xml" />
  344. <xi:include href="Zend_View-Helpers-Cycle.xml" />
  345. <xi:include href="Zend_View-Helpers-Partial.xml" />
  346. <xi:include href="Zend_View-Helpers-Placeholder.xml" />
  347. <xi:include href="Zend_View-Helpers-Doctype.xml" />
  348. <xi:include href="Zend_View-Helpers-HeadLink.xml" />
  349. <xi:include href="Zend_View-Helpers-HeadMeta.xml" />
  350. <xi:include href="Zend_View-Helpers-HeadScript.xml" />
  351. <xi:include href="Zend_View-Helpers-HeadStyle.xml" />
  352. <xi:include href="Zend_View-Helpers-HeadTitle.xml" />
  353. <xi:include href="Zend_View-Helpers-HtmlObject.xml" />
  354. <xi:include href="Zend_View-Helpers-InlineScript.xml" />
  355. <xi:include href="Zend_View-Helpers-Json.xml" />
  356. <xi:include href="Zend_View-Helpers-Navigation.xml" />
  357. <xi:include href="Zend_View-Helpers-Translate.xml" />
  358. </sect2>
  359. <sect2 id="zend.view.helpers.paths">
  360. <title>Helfer Pfade</title>
  361. <para>
  362. Wie bei den View Skripten kann der Controller für <classname>Zend_View</classname> auch
  363. einen Stapel an Pfaden festlegen, in dem nach Hilfsklassen gesucht werden soll.
  364. Standardmäßig sucht <classname>Zend_View</classname> in "Zend/View/Helper/*" nach
  365. Hilfsklassen. Du kannst <classname>Zend_View</classname> mit Hilfe der Methoden
  366. <methodname>setHelperPath()</methodname> und <methodname>addHelperPath()</methodname>
  367. mitteilen, auch in anderen Verzeichnissen zu suchen. Zusätzlich kann man einen
  368. Klassenpräfix angeben, um Helfer in dem bereit gestellten Pfad verwenden zu können, um
  369. eigene Namensräume für die Helferklassen zu verwenden. Standardmäßig wird
  370. 'Zend_View_Helper_' angenommen, wenn kein Präfix angegeben wird.
  371. </para>
  372. <programlisting language="php"><![CDATA[
  373. $view = new Zend_View();
  374. // Setze den Pfad auf /path/to/more/helpers, mit dem Präfix 'My_View_Helper'
  375. $view->setHelperPath('/path/to/more/helpers', 'My_View_Helper');
  376. ]]></programlisting>
  377. <para>
  378. Durch Verwendung der <methodname>addHelperPath()</methodname> Methode können die Pfade
  379. "gestapelt" werden. Wenn du Pfade zu diesem Stapelspeicher hinzufügst, wird
  380. <classname>Zend_View</classname> im zuletzt hinzugefügten Pfad nach der angeforderten
  381. Hilfsklasse schauen. Dies erlaubt dir, zu den vorhandenen Helfern weitere hinzufügen
  382. oder diese durch eigene zu ersetzen.
  383. </para>
  384. <programlisting language="php"><![CDATA[
  385. $view = new Zend_View();
  386. // Füge /path/to/some/helpers mit Klassenpräfix 'My_View_Helper' hinzu
  387. $view->addHelperPath('/path/to/some/helpers', 'My_View_Helper');
  388. // Füge /other/path/to/helpers mit Klassenpräfix 'Your_View_Helper' hinzu
  389. $view->addHelperPath('/other/path/to/helpers', 'Your_View_Helper');
  390. // wenn nun $this->helperName() aufgerufen wird, wird Zend_View zuerst nach
  391. // "/path/to/some/helpers/HelperName" mit dem Klassennamen
  392. // "Your_View_Helper_HelperName", dann nach
  393. // "/other/path/to/helpers/HelperName.php" mit dem Klassennamen
  394. // "My_View_Helper_HelperName", und zuletzt nach
  395. // "Zend/View/Helpers/HelperName.php" mit dem Klassennamen
  396. // "Zend_View_Helper_HelperName" schauen.
  397. ]]></programlisting>
  398. </sect2>
  399. <sect2 id="zend.view.helpers.custom">
  400. <title>Eigene Helfer schreiben</title>
  401. <para>
  402. Eigene Helfer zu schreiben ist einfach; du mußt nur diese Regeln befolgen:
  403. </para>
  404. <itemizedlist>
  405. <listitem>
  406. <para>
  407. Wärend das nicht strikt notwendig ist, ist es empfohlen entweder
  408. <classname>Zend_View_Helper_Interface</classname> zu implementieren oder
  409. <classname>Zend_View_Helper_Abstract</classname> zu erweitern wenn eigene Helfer
  410. erstellt werden. Eingeführt mit 1.6.0, definieren diese einfach die
  411. <methodname>setView()</methodname> Methode; trotzdem, in kommenden Releases, ist
  412. es geplant ein Strategy Pattern zu implementieren das vieles der Namensschemas
  413. einfacher mach wie anbei beschrieben. Wenn darauf aufgebaut wird hilft das, das
  414. der eigene Code Zukunftssicher ist.
  415. </para>
  416. </listitem>
  417. <listitem>
  418. <para>
  419. Der Klassenname muss mindestens auf den Helfernamen unter Verwendung der
  420. MixedCaps selber enden. Wenn du z.B. einen Helfer mit Namen "specialPurpose"
  421. schreibst, muss der Klassenname mindestens "SpecialPurpose" lauten. Man kann,
  422. und sollte, dem Klassennamen einen Präfix geben und es wird empfohlen,
  423. 'View_Helper' als Teil des Präfix zu verwenden: "My_View_Helper_SpecialPurpose"
  424. (man muss den Präfix mit oder oder abschließenden Unterstrich an
  425. <methodname>addHelperPath()</methodname> oder
  426. <methodname>setHelperPath()</methodname> übergeben).
  427. </para>
  428. </listitem>
  429. <listitem>
  430. <para>
  431. Die Klasse muss eine öffentliche Methode mit dem Namen des Helfers haben. Dies
  432. ist die Methode, welche vom View Skript durch "$this->specialPurpose()"
  433. aufgerufen wird. In unserem "specialPurpose" Beispiel, würde die notwendige
  434. Deklaration dieser Methode "public function specialPurpose()" lauten.
  435. </para>
  436. </listitem>
  437. <listitem>
  438. <para>
  439. Im Allgemeinen sollte die Klasse keine Ausgaben durch echo(), print() oder auf
  440. andere Weise erstellen. Stattdessen sollte es die auszugebenen Werte
  441. zurückgeben. Die zurückgegebenen Werte sollten entsprechend maskiert werden.
  442. </para>
  443. </listitem>
  444. <listitem>
  445. <para>
  446. Diese Klasse muss sich in einer Datei befinden, die nach der Helfermethode
  447. benannt ist. Bezogen auf unser "specialPurpose" Beispiel, muss der Dateiname
  448. "SpecialPurpose.php" lauten.
  449. </para>
  450. </listitem>
  451. </itemizedlist>
  452. <para>
  453. Platziere die Hilfsklasse irgendwo in deinem Stapelspeicher für Hilfspfade und
  454. <classname>Zend_View</classname> wird den Helfer automatisch für dich laden,
  455. instanziieren, speichern und ausführen.
  456. </para>
  457. <para>
  458. Hier ist ein Beispiel für unseren <classname>SpecialPurpose</classname> Helfer:
  459. </para>
  460. <programlisting language="php"><![CDATA[
  461. class My_View_Helper_SpecialPurpose extends Zend_View_Helper_Abstract
  462. {
  463. protected $_count = 0;
  464. public function specialPurpose()
  465. {
  466. $this->_count++;
  467. $output = "Ich habe 'The Jerk' {$this->_count} Mal(e) gesehen.";
  468. return htmlspecialchars($output);
  469. }
  470. }
  471. ]]></programlisting>
  472. <para>
  473. Dann rufst du in einem View Skript den <classname>SpecialPurpose</classname> Helfer so
  474. oft auf, wie du möchtest; er wird einmal instanziiert und bleibt für die Lebensdauer der
  475. <classname>Zend_View</classname> Instanz bestehen.
  476. </para>
  477. <programlisting language="php"><![CDATA[
  478. // denke daran, dass $this in deinem View Skript auf die
  479. // Zend_View Instanz verweist.
  480. echo $this->specialPurpose();
  481. echo $this->specialPurpose();
  482. echo $this->specialPurpose();
  483. ]]></programlisting>
  484. <para>
  485. Die Ausgabe wird in etwa so aussehen:
  486. </para>
  487. <programlisting language="php"><![CDATA[
  488. Ich habe 'The Jerk' 1 Mal(e) gesehen.
  489. Ich habe 'The Jerk' 2 Mal(e) gesehen.
  490. Ich habe 'The Jerk' 3 Mal(e) gesehen.
  491. ]]></programlisting>
  492. <para>
  493. Hier und da ist es notwendig das aufrufende <classname>Zend_View</classname> Objekt
  494. aufzurufen -- zum Beispiel, wenn es notwendig ist die registrierte Verschöüsselung zu
  495. verwenden, oder wenn ein anderes View Skript gerendert werden soll, als Teil des eigenen
  496. Helfers. Um Zugriff zum View Objekt zu erhalten, sollte die eigene Helfer Klasse eine
  497. <methodname>setView($view)</methodname> Methode wie folgt besitzen:
  498. </para>
  499. <programlisting language="php"><![CDATA[
  500. class My_View_Helper_ScriptPath
  501. {
  502. public $view;
  503. public function setView(Zend_View_Interface $view)
  504. {
  505. $this->view = $view;
  506. }
  507. public function scriptPath($script)
  508. {
  509. return $this->view->getScriptPath($script);
  510. }
  511. }
  512. ]]></programlisting>
  513. <para>
  514. Wenn die Helfer Klasse eine <methodname>setView()</methodname> Methode hat, wird diese
  515. aufgerufen wenn die Helfer Klasse das erste Mal instanziert wird, und das aktuelle View
  516. Objekt übergeben wird. Es liegt an einem selbst das Objekt in der Klasse zu fixieren,
  517. genau so wie herauszufinden wie auf dieses zugegriffen werden sollte.
  518. </para>
  519. <para>
  520. Wenn <classname>Zend_View_Helper_Abstract</classname> erweitert wird, muß diese Methode
  521. nicht selbst definiert werden da Sie schon vordefiniert ist.
  522. </para>
  523. </sect2>
  524. <sect2 id="zend.view.helpers.registering-concrete">
  525. <title>Konkrete Helper registrieren</title>
  526. <para>
  527. Manchmal ist es bequem einen View Helfer zu instanzieren, und diesen dann in der View zu
  528. registrieren. Ab Version 1.10.0 ist es jetzt möglich die Methode
  529. <methodname>registerHelper()</methodname> zu verwenden, welche zwei Argumente erwartet:
  530. das Helfer Objekt, und den Namen mit dem es registriert wird.
  531. </para>
  532. <programlisting language="php"><![CDATA[
  533. $helper = new My_Helper_Foo();
  534. // ...etwas konfigurieren oder dependency injection durchführen...
  535. $view->registerHelper($helper, 'foo');
  536. ]]></programlisting>
  537. <para>
  538. Wenn der Helfer eine <methodname>setView()</methodname> Methode hat, wird das View
  539. Objekt diese aufrufen und sich selbst bei der Registrierung in den Helfer injizieren.
  540. </para>
  541. <note>
  542. <title>Helfer-Namen sollten einer Methode entsprechen</title>
  543. <para>
  544. Das zweite Argument von <methodname>registerHelper()</methodname> ist der Name des
  545. Helfers. Eine entsprechender Methodenname sollte im Helfer existieren; andernfalls
  546. ruft <classname>Zend_View</classname> eine nicht existierende Methode aus wenn der
  547. Helfer ausgeführt wird, was einen fatalen PHP Fehler verursacht.
  548. </para>
  549. </note>
  550. </sect2>
  551. </sect1>