Zend_View-Helpers.xml 25 KB

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