Zend_View-Helpers-Placeholder.xml 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15157 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.view.helpers.initial.placeholder">
  5. <title>Platzhalter (PlaceHolder) Helfer</title>
  6. <para>
  7. Der <code>Placeholder</code> View Helfer wird verwendet um Inhalte zwischen View Skripten und View
  8. Instanzen persistent zu machen. Er bietet auch einige nützliche Features wie Inhalte zu vereinigen,
  9. Inhalte von View Skripten zu erfassen und Vor- sowie Nach-Texte zu Inhalten hinzuzufügen (und eigene
  10. Separatoren für vereinigte Inhalte).
  11. </para>
  12. <example id="zend.view.helpers.initial.placeholder.usage">
  13. <title>Grundsätzliche Verwendung von Platzhaltern</title>
  14. <para>
  15. Die grundsätzliche Verwendung von Platzhaltern ist die persistenz von View Daten. Jeder Aufruf des
  16. <code>Placeholder</code> Helfers erwartet einen Platzhalter Namen; der Helfer gibt dann ein
  17. Platzhalter Container Objekt zurück das entweder manipuliert oder einfach ausgegeben werden kann.
  18. </para>
  19. <programlisting role="php"><![CDATA[
  20. <?php $this->placeholder('foo')->set("Ein Text für später") ?>
  21. <?php
  22. echo $this->placeholder('foo');
  23. // Ausgabe "Ein Text für später"
  24. ?>
  25. ]]></programlisting>
  26. </example>
  27. <example id="zend.view.helpers.initial.placeholder.aggregation">
  28. <title>Platzhalter verwenden um Inhalt zu vereinigen</title>
  29. <para>
  30. Inhalt über Platzhalter zu vereinigen kann zeitweise auch sehr nützlich sein. Zum Beispiel kann ein
  31. View Skript ein variables Array besitzen von dem Nachrichten empfangen werden sollen um diese
  32. später darzustellen; ein späteres View Skript kann diese dann eruieren wie diese dargestellt werden
  33. sollen.
  34. </para>
  35. <para>
  36. Der <code>Placeholder</code> View Helfer verwendet Container die <code>ArrayObject</code> erweitern,
  37. und ein reichhaltiges Set von Features für die Manipulation von Arrays bieten. Zusätzlich bietet es
  38. eine Anzahl von Methoden für die Formatierung des Inhalts der im Container gespeichert ist:
  39. </para>
  40. <itemizedlist>
  41. <listitem>
  42. <para>
  43. <code>setPrefix($prefix)</code> setzt Text der dem Inhalt vorgesetzt wird.
  44. <code>getPrefix()</code> kann verwendet werden um jederzeit festzustellen wie die aktuellen
  45. Einstellungen sind.
  46. </para>
  47. </listitem>
  48. <listitem>
  49. <para>
  50. <code>setPostfix($prefix)</code> setzt Text der dem Inhalt angehängt wird.
  51. <code>getPostfix()</code> kann verwendet werden um jederzeit festzustellen wie die
  52. aktuellen Einstellungen sind.
  53. </para>
  54. </listitem>
  55. <listitem>
  56. <para>
  57. <code>setSeparator($prefix)</code> setzt Text mit dem zusammengefügte Inhalte seperiert
  58. werden. <code>getSeparator()</code> kann verwendet werden um jederzeit festzustellen wie die
  59. aktuellen Einstellungen sind.
  60. </para>
  61. </listitem>
  62. <listitem>
  63. <para>
  64. <code>setIndent($prefix)</code> kann verwendet werden um einen Markierungswert für
  65. den Inhalt zu setzen. Wenn ein Integer übergeben wird, wird diese Anzahl an Leerzeichen
  66. verwendet; wenn ein String übergeben wird, wird dieser String verwendet.
  67. <code>getIndent()</code> kann verwendet werden um jederzeit festzustellen wie die
  68. aktuellen Einstellungen sind.
  69. </para>
  70. </listitem>
  71. </itemizedlist>
  72. <programlisting role="php"><![CDATA[
  73. <!-- Erstes View Skript -->
  74. <?php $this->placeholder('foo')->exchangeArray($this->data) ?>
  75. ]]></programlisting>
  76. <programlisting role="php"><![CDATA[
  77. <!-- Späteres View Skript -->
  78. <?php
  79. $this->placeholder('foo')->setPrefix("<ul>\n <li>")
  80. ->setSeparator("</li><li>\n")
  81. ->setIndent(4)
  82. ->setPostfix("</li></ul>\n");
  83. ?>
  84. <?php
  85. echo $this->placeholder('foo');
  86. // Ausgabe als unsortierte Liste mit schöner Einrückung
  87. ?>
  88. ]]></programlisting>
  89. <para>
  90. Weil die <code>Placeholder</code> Container Objekte <code>ArrayObject</code> erweitern, können
  91. Inhalte einem speziellen Schlüssel im Container sehr einfach zugeordnet werden, statt diese einfach
  92. an den Container anzufügen. Auf Schlüssel kann entweder als Objekt Eigenschaften oder als Array
  93. Schlüssel zugegriffen werden.
  94. </para>
  95. <programlisting role="php"><![CDATA[
  96. <?php $this->placeholder('foo')->bar = $this->data ?>
  97. <?php echo $this->placeholder('foo')->bar ?>
  98. <?php
  99. $foo = $this->placeholder('foo');
  100. echo $foo['bar'];
  101. ?>
  102. ]]></programlisting>
  103. </example>
  104. <example id="zend.view.helpers.initial.placeholder.capture">
  105. <title>Verwenden von Platzhaltern um Inhalt zu erfassen</title>
  106. <para>
  107. Gelegentlich will man Inhalte für einen Platzhalter in einem View Skript haben die einfachst als
  108. Vorlage zu verwenden sind; der <code>Placeholder</code> View Helfer erlaubt es willkürliche
  109. Inhalte zu erfassen um diese später durch Verwendung der folgenden API darstellen zu können.
  110. </para>
  111. <itemizedlist>
  112. <listitem>
  113. <para>
  114. <code>captureStart($type, $key)</code> beginnt die Erfassung der Inhalte.
  115. </para>
  116. <para>
  117. <code>$type</code> sollte eine der <code>Placeholder</code> Konstanten <code>APPEND</code>
  118. oder <code>SET</code> sein. <code>APPEND</code> fügt erfasste Inhalte der Liste der aktuellen
  119. Inhalte im Placeholder an; <code>SET</code> verwendet erfasste Inhalte als einzigen Wert
  120. für den Platzhalter (überschreibt potentiell alle vorherigen Inhalte). Standardmäßig ist
  121. <code>$type</code> <code>APPEND</code>.
  122. </para>
  123. <para>
  124. <code>$key</code> kann verwendet werden um einen speziellen Schlüssel im Placeholder Container
  125. zu spezifizieren an dem der Inhalt erfasst werden soll.
  126. </para>
  127. <para>
  128. <code>captureStart()</code> sperrt die Erfassung bis <code>captureEnd()</code> aufgerufen
  129. wurde; Erfassungen können nicht mit dem selben Placeholder Container verschachtelt werden.
  130. Das führt zu einer Ausnahme.
  131. </para>
  132. </listitem>
  133. <listitem>
  134. <para>
  135. <code>captureEnd()</code> stoppt die Erfassung von Inhalten, und platziert Ihn im
  136. Container Objekt anhängig davon wie <code>captureStart()</code> aufgerufen wurde.
  137. </para>
  138. </listitem>
  139. </itemizedlist>
  140. <programlisting role="php"><![CDATA[
  141. <!-- Standarderfassung: anhängen -->
  142. <?php $this->placeholder('foo')->captureStart();
  143. foreach ($this->data as $datum): ?>
  144. <div class="foo">
  145. <h2><?php echo $datum->title ?></h2>
  146. <p><?php echo $datum->content ?></p>
  147. </div>
  148. <?php endforeach; ?>
  149. <?php $this->placeholder('foo')->captureEnd() ?>
  150. <?php echo $this->placeholder('foo') ?>
  151. ]]></programlisting>
  152. <programlisting role="php"><![CDATA[
  153. <!-- Erfassung zum Schlüssel -->
  154. <?php $this->placeholder('foo')->captureStart('SET', 'data');
  155. foreach ($this->data as $datum): ?>
  156. <div class="foo">
  157. <h2><?php echo $datum->title ?></h2>
  158. <p><?php echo $datum->content ?></p>
  159. </div>
  160. <?php endforeach; ?>
  161. <?php $this->placeholder('foo')->captureEnd() ?>
  162. <?php echo $this->placeholder('foo')->data ?>
  163. ]]></programlisting>
  164. </example>
  165. <sect4 id="zend.view.helpers.initial.placeholder.implementations">
  166. <title>Konkrete Platzhalter Implementationen</title>
  167. <para>
  168. Zend Framework kommt mit einer Anzahl an "konkreten" Platzhalter Implementationen. Diese sind für
  169. üblich verwendete Platzhalter: Doctype, Seitentitel, und verschiedene &lt;head&gt; Elemente. In allen
  170. Fällen gibt der Aufruf des Platzhalters ohne Argumente das Element selbst zurück.
  171. </para>
  172. <para>
  173. Die Dokumentation für jedes Element wird separat behandelt, wie anbei beschrieben:
  174. </para>
  175. <itemizedlist>
  176. <listitem><para>
  177. <link linkend="zend.view.helpers.initial.doctype">Doctype</link>
  178. </para></listitem>
  179. <listitem><para>
  180. <link linkend="zend.view.helpers.initial.headlink">HeadLink</link>
  181. </para></listitem>
  182. <listitem><para>
  183. <link linkend="zend.view.helpers.initial.headmeta">HeadMeta</link>
  184. </para></listitem>
  185. <listitem><para>
  186. <link linkend="zend.view.helpers.initial.headscript">HeadScript</link>
  187. </para></listitem>
  188. <listitem><para>
  189. <link linkend="zend.view.helpers.initial.headstyle">HeadStyle</link>
  190. </para></listitem>
  191. <listitem><para>
  192. <link linkend="zend.view.helpers.initial.headtitle">HeadTitle</link>
  193. </para></listitem>
  194. <listitem><para>
  195. <link linkend="zend.view.helpers.initial.inlinescript">InlineScript</link>
  196. </para></listitem>
  197. </itemizedlist>
  198. </sect4>
  199. </sect3>
  200. <!--
  201. vim:se ts=4 sw=4 et:
  202. -->