Zend_Layout-QuickStart.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.layout.quickstart">
  5. <title>Zend_Layout Schnellstart</title>
  6. <para>
  7. Es gibt zwei primäre Verwendungen für <classname>Zend_Layout</classname>: Mit dem Zend Framework MVC, und ohne.
  8. </para>
  9. <sect2 id="zend.layout.quickstart.layouts">
  10. <title>Layout Skripte</title>
  11. <para>
  12. In beiden Fällen, müssen trotzdem Layout Skripte erstellt werden. Layout Sktipte verwenden einfach
  13. Zend_View (oder welche View Implementation auch immer verwendet wird). Layout Variablen werden
  14. mit einem <classname>Zend_Layout</classname>
  15. <link linkend="zend.view.helpers.initial.placeholder">Platzhalter</link> registriert, und es kann
  16. auf Sie über den Platzhalter Helfer zugegriffen werden oder dadurch das Sie als Objekt Eigenschaften
  17. vom Layout Objekt über den Layout Helfer geholt werden.
  18. </para>
  19. <para>
  20. Als Beispiel:
  21. </para>
  22. <programlisting role="php"><![CDATA[
  23. <!DOCTYPE html
  24. PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  25. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  26. <html>
  27. <head>
  28. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  29. <title>Meine Seite</title>
  30. </head>
  31. <body>
  32. <?php
  33. // Holt den 'content' Schlüssel durch Verwendung des Layout Helfers:
  34. echo $this->layout()->content;
  35. // Holt den 'foo' Schlüssel durch Verwendung des Platzhalter Helfers:
  36. echo $this->placeholder('Zend_Layout')->foo;
  37. // Holt das Layout Objekt und empfängt verschiedene Schlüssel von Ihm:
  38. $layout = $this->layout();
  39. echo $layout->bar;
  40. echo $layout->baz;
  41. ?>
  42. </body>
  43. </html>
  44. ]]></programlisting>
  45. <para>
  46. Weil <classname>Zend_Layout</classname> <classname>Zend_View</classname> für die Darstellung verwendet, kann auch jeder
  47. registrierte View Helfer verwendet werden, und auch auf jede zuvor zugeordnete View Variable kann
  48. zugegriffen werden. Sehr hilfreich sind die verschiedenen
  49. <link linkend="zend.view.helpers.initial.placeholder">Platzhalter Helfer</link>, da diese das
  50. Empfangen von Inhalt für einen Bereich wie die &lt;head&gt; Sektion, Navigation usw. erlauben:
  51. </para>
  52. <programlisting role="php"><![CDATA[
  53. <!DOCTYPE html
  54. PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  55. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  56. <html>
  57. <head>
  58. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  59. <?php echo $this->headTitle() ?>
  60. <?php echo $this->headScript() ?>
  61. <?php echo $this->headStyle() ?>
  62. </head>
  63. <body>
  64. <?php echo $this->render('header.phtml') ?>
  65. <div id="nav"><?php echo $this->placeholder('nav') ?></div>
  66. <div id="content"><?php echo $this->layout()->content ?></div>
  67. <?php echo $this->render('footer.phtml') ?>
  68. </body>
  69. </html>
  70. ]]></programlisting>
  71. </sect2>
  72. <sect2 id="zend.layout.quickstart.mvc">
  73. <title>Zend_Layout mit dem Zend Framework MVC verwenden</title>
  74. <para>
  75. <classname>Zend_Controller</classname> bietet ein reiches Set von Funktionalitäten für Erweiterung mit seinen
  76. <link linkend="zend.controller.plugins">Front Kontroller Plugins</link> und
  77. <link linkend="zend.controller.actionhelpers">Action Kontroller Helfern</link>.
  78. <classname>Zend_View</classname> hat auch <link linkend="zend.view.helpers">Helfer</link>.
  79. <classname>Zend_Layout</classname> nimmt Vorteile wahr von diesen verschiedenen Erweiterungspunkten wenn es
  80. mit den MVC Komponenten verwendet wird.
  81. </para>
  82. <para>
  83. <classname>Zend_Layout::startMvc()</classname> erstellt eine Instanz von <classname>Zend_Layout</classname> mit jeder
  84. optionalen Konfiguration die angegeben wird. Anschließend wird ein Front Kontroller Plugin
  85. registriert das das Layout mit jedem Anwendungsinhalt darstellt sobald die Dispatch Schleife
  86. fertiggestellt ist, und registriert einen Action Helfer der den Zugriff auf das Layout Objekt
  87. vom Action Kontroller aus gestattet. Zusätzlich kann jederzeit die Layout Instanz vom View
  88. Skript geholt werden indem der <code>layout</code> View Helfer verwendet wird.
  89. </para>
  90. <para>
  91. Zuerst sehen wir uns an wie Zend_Layout initialisiert wird um es mit dem MVC zu verwenden:
  92. </para>
  93. <programlisting role="php"><![CDATA[
  94. // In der Bootstrap Datei:
  95. Zend_Layout::startMvc();
  96. ]]></programlisting>
  97. <para>
  98. <code>startMvc()</code> kann ein optionales Array von Optionen oder ein <classname>Zend_Config</classname>
  99. Objekt entgegennehmen um die Instanz anzupassen; diese Optionen werden detailiert in
  100. <xref linkend="zend.layout.options" /> beschrieben.
  101. </para>
  102. <para>
  103. In einem Action Controller, kann anschließend auf die Layout Instanz als Action Helfer zugegriffen
  104. werden:
  105. </para>
  106. <programlisting role="php"><![CDATA[
  107. class FooController extends Zend_Controller_Action
  108. {
  109. public function barAction()
  110. {
  111. // Layouts in dieser Aktion deaktivieren:
  112. $this->_helper->layout->disableLayout();
  113. }
  114. public function bazAction()
  115. {
  116. // Ein anderes Layout Skript in dieser Action verwenden:
  117. $this->_helper->layout->setLayout('foobaz');
  118. };
  119. }
  120. ]]></programlisting>
  121. <para>
  122. Im View Skript kann dann auf das Layout Objekt über den <code>layout</code> View Helfer zugegriffen
  123. werden. Dieser View Helfer ist etwas anders als andere da er keine Argumente entgegennimmt und ein
  124. Objekt statt einem Stringwert zurückgibt. Das erlaubt sofortige Methodenaufrufe auf dem Layout
  125. Objekt:
  126. </para>
  127. <programlisting role="php"><![CDATA[
  128. $this->layout()->setLayout('foo'); // alternatives Layout setzen
  129. ]]></programlisting>
  130. <para>
  131. Die im MVC registrierte <classname>Zend_Layout</classname> Instanz kann jederzeit über die statische
  132. <code>getMvcInstance()</code> Methode geholt werden:
  133. </para>
  134. <programlisting role="php"><![CDATA[
  135. // Gibt null zurück wenn startMvc() nicht zuerst aufgerufen wurde
  136. $layout = Zend_Layout::getMvcInstance();
  137. ]]></programlisting>
  138. <para>
  139. Letztendlich hat das Front Controller Plugin von <classname>Zend_Layout</classname> ein wichtiges Feature
  140. zusätzlich zur Darstellung des Layouts: Es empfängt alle benannte Segmente vom Antwortobjekt und
  141. ordnet diese als Layout Variablen zu, wobei das 'default' Segment der 'content' Variable zugeordnet
  142. wird. Das erlaubt es auf den Anwendungsinhalt zugreifen zu können und es in View Skripten
  143. darzustellen.
  144. </para>
  145. <para>
  146. Als Beispiel, nehmen wir an das der Code zuerst <code>FooController::indexAction()</code>
  147. auslöst, welches einige Inhalte im standardmäßigen Antwortobjekt darstellt, und dann zu
  148. <code>NavController::menuAction()</code> weiterleitet, welches Inhalt im 'nav' Antwortobjekt
  149. darstellt. Letztendlich wird auf <code>CommentController::fetchAction()</code> weitergeleitet und
  150. einige Kommentare geholt, aber diese werden auch im standard Antwortobjekt dargestellt. (was
  151. Inhalt zu diesem Segment anfügt). Das View Skript kann dann jedes separat darstellen:
  152. </para>
  153. <programlisting role="php"><![CDATA[
  154. <body>
  155. <!-- Darstellung von /nav/menu -->
  156. <div id="nav"><?php echo $this->layout()->nav ?></div>
  157. <!-- Darstellung von /foo/index + /comment/fetch -->
  158. <div id="content"><?php echo $this->layout()->content ?></div>
  159. </body>
  160. ]]></programlisting>
  161. <para>
  162. Dieses Feature ist teilweise nützlich wenn es in Verbindung mit dem ActionStack
  163. <link linkend="zend.controller.actionhelpers.actionstack">Action Helfer</link> und
  164. <link linkend="zend.controller.plugins.standard.actionstack">Plugin</link> verwendet wird, welche
  165. verwendet werden können um einen Stack von Aktionen zu definieren der durchgelaufen wird, und welcher
  166. angepasste Seiten erstellt.
  167. </para>
  168. </sect2>
  169. <sect2 id="zend.layout.quickstart.standalone">
  170. <title>Zend_Layout als eienständige Komponente verwenden</title>
  171. <para>
  172. Als eigenständige Komponente bietet Zend_Layout nicht annähernd so viele Features oder so viel
  173. Bequemlichkeit wie wenn es mit MVC verwendet wird. Trotzdem hat es zwie grundsätzliche Vorteile:
  174. </para>
  175. <itemizedlist>
  176. <listitem>
  177. <para>
  178. Abgrenzung von Layout Variablen.
  179. </para>
  180. </listitem>
  181. <listitem>
  182. <para>
  183. Isolation vom Layout View Skript von anderen View Skripten.
  184. </para>
  185. </listitem>
  186. </itemizedlist>
  187. <para>
  188. Wenn es als eigenständige Komponente verwendet wird, muß einfach das Layout Objekt instanziiert
  189. werden, die unterschiedlichen Zugriffsmethoden verwendet werden um Stati zu setzen, Variablen als
  190. Objekt Eigenschaften gesetzt, und das Layout dargestellt werden:
  191. </para>
  192. <programlisting role="php"><![CDATA[
  193. $layout = new Zend_Layout();
  194. // Einen Layout Skript Pfad setzen:
  195. $layout->setLayoutPath('/path/to/layouts');
  196. // Einige Variablen setzen:
  197. $layout->content = $content;
  198. $layout->nav = $nav;
  199. // Ein unterschiedliches Layout Skript auswählen:
  200. $layout->setLayout('foo');
  201. // Letztendlich das Layout darstellen
  202. echo $layout->render();
  203. ]]></programlisting>
  204. </sect2>
  205. <sect2 id="zend.layout.quickstart.example">
  206. <title>Beispiel Layout</title>
  207. <para>
  208. Machmal ist ein Bild mehr Wert als tausend Wörter. Das folgende ist ein Beispiel Layout Skript
  209. das zeigt wie alles zusammenkommen könnte.
  210. </para>
  211. <para>
  212. <inlinegraphic align="center" valign="middle"
  213. fileref="figures/zend.layout.quickstart.example.png" format="PNG" />
  214. </para>
  215. <para>
  216. Die aktuelle Reihenfolge der Elemente kann variieren, abhängig vom CSS das eingestellt wurde;
  217. zum Beispiel, wenn absolute Positionen verwendet werden, kann es möglich sein das die Navigation
  218. später im Dokument angezeigt wird, aber immer noch ganz oben gezeigt wird; das selbe könnte
  219. für die Sidebar oder den Header gelten. Der aktuelle Mechanismum des Holens von Inhalt bleibt
  220. trotzdem der selbe.
  221. </para>
  222. </sect2>
  223. </sect1>
  224. <!--
  225. vim:se ts=4 sw=4 et:
  226. -->