Zend_Layout-Advanced.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.layout.advanced">
  5. <title>Erweiterte Verwendung von Zend_Layout</title>
  6. <para>
  7. <classname>Zend_Layout</classname> hat eine Vielzahl an Verwendungsmöglichkeiten für den fortgeschrittenen
  8. Entwickler der es für seine unterschiedlichen View Implementationen, Dateisystem Layouts, und anderes
  9. adaptieren will.
  10. </para>
  11. <para>
  12. Die Hauptpunkte der Erweiterung sind:
  13. </para>
  14. <itemizedlist>
  15. <listitem>
  16. <para>
  17. <emphasis>Eigene View Objekte.</emphasis> <classname>Zend_Layout</classname> erlaubt es jede Klasse
  18. zu verwenden die <classname>Zend_View_Interface</classname> implementiert.
  19. </para>
  20. </listitem>
  21. <listitem>
  22. <para>
  23. <emphasis>Eigene Front Kontroller Plugins.</emphasis> <classname>Zend_Layout</classname> wird mit einem
  24. Standard Front Kontroller Plugin ausgeliefert der das Layout automatisch darstellt bevor die
  25. Antwort zurückgegeben wird. Es kann ein eigenes Plugin verwendet werden.
  26. </para>
  27. </listitem>
  28. <listitem>
  29. <para>
  30. <emphasis>Eigene Action Helfer.</emphasis> <classname>Zend_Layout</classname> wird mit einem Standard
  31. Action Helfer ausgeliefert der für die meiden Zwecke ausreichend sein sollte da er ein dummer
  32. Proxy für das Layout Objekt selbst ist.
  33. </para>
  34. </listitem>
  35. <listitem>
  36. <para>
  37. <emphasis>Eigene Auflösung von Layout Skript Pfaden</emphasis>. <classname>Zend_Layout</classname> erlaubt
  38. es einen eigenen <link linkend="zend.filter.inflector">Beugungsmechanismum</link> für die
  39. Auflösung der Layout Skript Pfade zu verwenden, oder einfach die beigefügte Beugung zu verändern
  40. und eigene Beugungsregeln zu spezifizieren.
  41. </para>
  42. </listitem>
  43. </itemizedlist>
  44. <sect2 id="zend.layout.advanced.view">
  45. <title>Eigene View Objekte</title>
  46. <para>
  47. <classname>Zend_Layout</classname> erlaubt es jede Klasse für die Darstellung der Layout Skripte zu verwenden
  48. die <classname>Zend_View_Interface</classname> implementiert oder <classname>Zend_View_Abstract</classname> erweitert.
  49. Es muß einfach das eigene View Objekt als Parameter dem Konstruktor/<code>startMvc()</code>
  50. übergeben werden, oder es mit der <code>setView()</code> Zugriffsmethode gesetzt werden:
  51. </para>
  52. <programlisting role="php"><![CDATA[
  53. $view = new My_Custom_View();
  54. $layout->setView($view);
  55. ]]></programlisting>
  56. <note>
  57. <title>Nicht alle Zend_View Implementationen sind gleich</title>
  58. <para>
  59. Wärend es <classname>Zend_Layout</classname> erlaubt jede Klasse zu verwenden die
  60. <classname>Zend_View_Interface</classname> implementiert, können Fälle auftreten in denen es nicht
  61. möglich ist die verschiedenen <classname>Zend_View</classname> Helfer anzupassen, speziell die
  62. Layout und <link linkend="zend.view.helpers.initial.placeholder">Platzhalter</link> Helfer.
  63. Das ist weil <classname>Zend_Layout</classname> die Variablen die im Objekt gesetzt werden über
  64. sich selbst und <link linkend="zend.view.helpers.initial.placeholder">Platzhalter</link>
  65. bereitstellt.
  66. </para>
  67. <para>
  68. Wenn eine eigene <classname>Zend_View</classname> Implementation verwendet werden soll die diese Helfer
  69. nicht unterstützt, muß ein Weg gefunden werden um die Layout Variablen in die View zu bekommen.
  70. Das kann entweder durch die Erweiterung vom <classname>Zend_Layout</classname> Objekt und der Anpassung
  71. der <code>render()</code> Methode zur Übergabe von Variablen zur View geschehen, oder durch
  72. die Erstellung einer eigenen Plugin Klasse die diese vor der Darstellung des Layouts übergibt.
  73. </para>
  74. <para>
  75. Alternativ kann auf diese Variablen, wenn die View Implementation jegliche Art von Plugin
  76. Möglichkeiten unterstützt, über die 'Zend_Layout' Platzhalter zugegriffen werden, indem der
  77. <link linkend="zend.view.helpers.initial.placeholder">Platzhalter Helfer</link> verwendet wird:
  78. </para>
  79. <programlisting role="php"><![CDATA[
  80. $placeholders = new Zend_View_Helper_Placeholder();
  81. $layoutVars = $placeholders->placeholder('Zend_Layout')->getArrayCopy();
  82. ]]></programlisting>
  83. </note>
  84. </sect2>
  85. <sect2 id="zend.layout.advanced.plugin">
  86. <title>Eigene Front Controller Plugins</title>
  87. <para>
  88. Wenn <classname>Zend_Layout</classname> mit den MVC Komponenten verwendet wird, registriert es ein Front
  89. Kontroller Plugin das das Layout als letzte Aktion darstellt bevor die Bearbeitungsschleife
  90. beendet wird. In den meisten Fällen, wird das Standardplugin ausreichen, aber sollte es gewünscht
  91. sein ein eigenes zu schreiben, kann der Name der Pluginklasse die geladen werden soll durch die
  92. übergabe der <code>pluginClass</code> Option an die <code>startMvc()</code> Methode spezifiziert
  93. werden.
  94. </para>
  95. <para>
  96. Jede Plugin Klasse die für diesen Zweck geschrieben wird, muß
  97. <classname>Zend_Controller_Plugin_Abstract</classname> erweitern, und sollte eine Instanz eines Layout Objektes
  98. als Instanz für den Konstruktor akzeptieren. Andernfalls sind die Details der Implementation in
  99. eigenen Händen.
  100. </para>
  101. <para>
  102. Die Standardmäßig verwendete Plugin Klasse ist <classname>Zend_Layout_Controller_Plugin_Layout</classname>.
  103. </para>
  104. </sect2>
  105. <sect2 id="zend.layout.advanced.helper">
  106. <title>Eigene Action Helfer</title>
  107. <para>
  108. Wenn <classname>Zend_Layout</classname> mit den MVC Komponenten verwendet wird, registriert es einen Action
  109. Controller Helfer mit dem Helfer Broker. Der Standardhelfer,
  110. <classname>Zend_Layout_Controller_Action_Helper_Layout</classname> arbeitet als dummer Proxy zur Layout
  111. Objekt Instanz selbst, und sollte für die meisten Zwecke ausreichend sein.
  112. </para>
  113. <para>
  114. Sollte es gewünscht sein eigene Funktionalitäten zu schreiben, kann einfach eine Action Helfer Klasse
  115. geschrieben werden die <classname>Zend_Controller_Action_Helper_Abstract</classname> erweitert und den
  116. Klassennamen als <code>helperClass</code> Option an die <code>startMvc()</code> Methode übergeben
  117. werden. Details der Implementiert oblieben jedem selbst.
  118. </para>
  119. </sect2>
  120. <sect2 id="zend.layout.advanced.inflector">
  121. <title>Auflösung eigener Layout Skript Pfade: Verwenden der Beugung</title>
  122. <para>
  123. <classname>Zend_Layout</classname> verwendet <classname>Zend_Filter_Inflector</classname> um eine Filterkette zu
  124. erstellen für die Übersetzung eines Layout Namens zu einem Layout Skript Pfad. Standardmäßig
  125. verwendet es die 'Word_CamelCaseToDash' Regeln gefolgt von 'StringToLower' und dem Anhang 'phtml' um
  126. den Namen in einen Pfad zu transformieren. Einige Beispiele:
  127. </para>
  128. <itemizedlist>
  129. <listitem>
  130. <para>
  131. 'foo' wird zu 'foo.phtml' transformiert.
  132. </para>
  133. </listitem>
  134. <listitem>
  135. <para>
  136. 'FooBarBaz' wird zu 'foo-bar-baz.phtml' transformiert.
  137. </para>
  138. </listitem>
  139. </itemizedlist>
  140. <para>
  141. Es gibt drei Optionen für die Änderung der Beugung: Änderung des Beuzungszieles und/oder des
  142. View Suffix über <classname>Zend_Layout</classname> Zugriffsmethoden, änderung der Beugungsregeln und des Ziels
  143. der Beugung die mit der <classname>Zend_Layout</classname> Instanz gekoppelt ist, oder Erstellung einer
  144. eigenen Beugungsinstanz und dessen Übergabe an <classname>Zend_Layout::setInflector()</classname>.
  145. </para>
  146. <example id="zend.layout.advanced.inflector.accessors">
  147. <title>Verwenden von Zend_Layout Zugriffsmethoden zur Änderung der Beugung</title>
  148. <para>
  149. Der standardmäßige <classname>Zend_Layout</classname> Beugungsmechanismus verwendet statische
  150. Referenzen für das Ziel und View Skript Suffix, und besitzt Zugriffsmethoden für das setzen
  151. dieser Werte.
  152. </para>
  153. <programlisting role="php"><![CDATA[
  154. // Setzen des Beugungsziel:
  155. $layout->setInflectorTarget('layouts/:script.:suffix');
  156. // Setzen des Layout View Skript Suffix:
  157. $layout->setViewSuffix('php');
  158. ]]></programlisting>
  159. </example>
  160. <example id="zend.layout.advanced.inflector.directmodification">
  161. <title>Direkte Änderung der Zend_Layout Beugung</title>
  162. <para>
  163. Beugung hat ein Ziel und ein oder mehrere Regeln. Das Standardziel das von
  164. <classname>Zend_Layout</classname> verwendet wird ist: ':script.:suffix'; ':script' wird als registrierter
  165. Layoutname übergeben, wärend ':suffix' eine statische Regel der Beugung ist.
  166. </para>
  167. <para>
  168. Angenommen man will das das Layout Skript mit der Endung 'html' endet, und es ist
  169. gewünscht das MixedCase und camelCased Wörter mit Unterstrichen statt Bindestrichen
  170. getrennt werden und der Name nicht kleingeschrieben wird. Zusätzlich ist es
  171. gewünscht in einem 'layouts' Unterverzeichnis nach den Skripten nachzuschauen.
  172. </para>
  173. <programlisting role="php"><![CDATA[
  174. $layout->getInflector()->setTarget('layouts/:script.:suffix')
  175. ->setStaticRule('suffix', 'html')
  176. ->setFilterRule(array('Word_CamelCaseToUnderscore'));
  177. ]]></programlisting>
  178. </example>
  179. <example id="zend.layout.advanced.inflector.custom">
  180. <title>Eigene Beugung</title>
  181. <para>
  182. In den meisten Fällen ist es ausreichend den bestehenden Beugungsmechanismus zu verändern.
  183. Trotzdem kann man eine Beugung haben die in verschiedenen Orten verwendet werden soll, mit
  184. unterschiedlichen Objekten von unterschiedlichen Typen. <classname>Zend_Layout</classname> unterstützt das.
  185. </para>
  186. <programlisting role="php"><![CDATA[
  187. $inflector = new Zend_Filter_Inflector('layouts/:script.:suffix');
  188. $inflector->addRules(array(
  189. ':script' => array('Word_CamelCaseToUnderscore'),
  190. 'suffix' => 'html'
  191. ));
  192. $layout->setInflector($inflector);
  193. ]]></programlisting>
  194. </example>
  195. <note>
  196. <title>Beugung kann ausgeschaltet werden</title>
  197. <para>
  198. Beugung kann ausgeschaltet und eingeschaltet werden indem eine zugriffsmethode auf dem
  199. <classname>Zend_Layout</classname> Objekt verwendet wird. Das kann nützlich sein wenn man einen
  200. absoluten Pfad für ein Layout Skript spezifizieren will, oder man weiß das der Mechanismus
  201. den man für die Spezifikation des Layout Skripts verwenden will, keine Beugung benötigt.
  202. Es können einfach die <code>enableInflection()</code> und <code>disableInflection()</code>
  203. Methoden verwendet werden.
  204. </para>
  205. </note>
  206. </sect2>
  207. </sect1>
  208. <!--
  209. vim:se ts=4 sw=4 et:
  210. -->