Zend_View-Helpers.xml 27 KB

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