quickstart-create-layout.xml 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="learning.quickstart.create-layout">
  5. <title>Ein Layout erstellen</title>
  6. <para>
  7. Wie man festgestellen kann waren die View Skripte im vorhergehenden Kapitel
  8. <acronym>HTML</acronym> Fragmente- und keine kompletten Seiten. Das ist so gewünscht; wir
  9. wollen das unsere Aktionen nur den Inhalt zurückgeben der für die Aktion selbst relevant
  10. ist, und nicht die Anwendung als ganzes.
  11. </para>
  12. <para>
  13. Jetzt müssen wir den erstellten Inhalt zu einer kompletten <acronym>HTML</acronym> Seite
  14. zusammenfügen. Wir wollen auch ein konsistentes Aussehen und Feeling für die Anwendung
  15. haben. Wir wollen ein globales Sitelayout verwenden um beide Arbeiten zu ermöglichen.
  16. </para>
  17. <para>
  18. Es gibt zwei Design Pattern die Zend Framework verwendet um Layouts zu implementieren:
  19. <ulink url="http://martinfowler.com/eaaCatalog/twoStepView.html">Two Step View</ulink> und
  20. <ulink
  21. url="http://www.oracle.com/technetwork/java/compositeview-137722.html">Composite
  22. View</ulink>. <emphasis>Two Step View</emphasis> wird normalerweise mit dem <ulink
  23. url="http://www.martinfowler.com/eaaCatalog/transformView.html">Transform View</ulink>
  24. Pattern assoziiert; die grundsätzliche Idee besteht darin das die View der Anwendung eine
  25. Repräsentation erstellt die dann in die Master View für letzte Transformationen injiziert
  26. wird. Das <emphasis>Composite View</emphasis> Pattern arbeitet mit einer View die aus ein
  27. oder mehreren atomischen Anwendungs Views gemacht ist.
  28. </para>
  29. <para>
  30. Im Zend Framework kombiniert <link linkend="zend.layout">Zend_Layout</link> die Ideen hinter
  31. diesen Pattern. Statt dass jedes Action View Skript Site-weite Artefakte einfügen muss,
  32. können Sie sich einfach auf Ihre eigenen Beantwortungen konzentrieren.
  33. </para>
  34. <para>
  35. Natürlich benötigt man trotzdem Anwendungs-spezifische Informationen im Site-weiten View
  36. Skript. Glücklicherweise bietet Zend Framework eine Anzahl von View
  37. <emphasis>Platzhaltern</emphasis> die es erlauben solche Informationen von den Action View
  38. Skripten zu bekommen.
  39. </para>
  40. <para>
  41. Um mit <classname>Zend_Layout</classname> zu beginnen müssen wir als erstes die Bootstrap
  42. informieren das Sie die <classname>Layout</classname> Ressource verwenden soll. Das kann
  43. getan werden indem der Befehl <command>zf enable layout</command> verwendet wird:
  44. </para>
  45. <programlisting language="shell"><![CDATA[
  46. % zf enable layout
  47. Layouts have been enabled, and a default layout created at
  48. application/layouts/scripts/layout.phtml
  49. A layout entry has been added to the application config file.
  50. ]]></programlisting>
  51. <para>
  52. Wie vom Kommando notiert wird <filename>application/configs/application.ini</filename>
  53. aktualisiert und enthält jetzt das folgende im Abschnitt <constant>production</constant>:
  54. </para>
  55. <programlisting language="ini"><![CDATA[
  56. ; application/configs/application.ini
  57. ; Zum Abschnitt [production] hinzufügen:
  58. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  59. ]]></programlisting>
  60. <para>
  61. Die endgültige <acronym>INI</acronym> Datei sollte wie folgt aussehen:
  62. </para>
  63. <programlisting language="ini"><![CDATA[
  64. ; application/configs/application.ini
  65. [production]
  66. ; PHP Einstellungen die initialisiert werden sollen
  67. phpSettings.display_startup_errors = 0
  68. phpSettings.display_errors = 0
  69. includePaths.library = APPLICATION_PATH "/../library"
  70. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  71. bootstrap.class = "Bootstrap"
  72. appnamespace = "Application"
  73. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  74. resources.frontController.params.displayExceptions = 0
  75. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  76. [staging : production]
  77. [testing : production]
  78. phpSettings.display_startup_errors = 1
  79. phpSettings.display_errors = 1
  80. [development : production]
  81. phpSettings.display_startup_errors = 1
  82. phpSettings.display_errors = 1
  83. ]]></programlisting>
  84. <para>
  85. Diese Direktive sagt der Anwendung das Sie nach Layout View Skripten unter
  86. <filename>application/layouts/scripts</filename> nachschauen soll. Wenn man den
  87. Verzeichnisbaum betrachtet sieht man das dieses Verzeichnis jetzt, zusammen mit der Datei
  88. <filename>layout.phtml</filename>, erstellt wurde.
  89. </para>
  90. <para>
  91. Wir wollen auch sicherstellen das wir eine XHTML DocType Deklaration für unsere Anwendung
  92. haben. Um das zu aktivieren mussen wir eine Ressource zu unserer Bootstrap hinzufügen.
  93. </para>
  94. <para>
  95. Der einfachste Weg um eine Bootstrap Ressource hinzuzufügen ist es einfach eine
  96. geschützte Methode zu erstellen die mit der Phrase <methodname>_init</methodname> beginnt.
  97. In diesem Fall wollen wir den Doctype initialisieren, also erstellen wir eine
  98. <methodname>_initDoctype()</methodname> Methode in unserer Bootstrap Klasse:
  99. </para>
  100. <programlisting language="php"><![CDATA[
  101. // application/Bootstrap.php
  102. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  103. {
  104. protected function _initDoctype()
  105. {
  106. }
  107. }
  108. ]]></programlisting>
  109. <para>
  110. In dieser Methode müssen wir der View sagen das Sie den richtigen DocType verwenden soll.
  111. Aber wo kommt das View Objekt her? Die einfachste Lösung ist die Initialisierung der
  112. <classname>View</classname> Ressource; sobald wir Sie haben können wir das View Objekt
  113. aus der Bootstrap holen und verwenden.
  114. </para>
  115. <para>
  116. Um die View Ressource zu initialisieren ist die folgende Zeile in der Sektion
  117. <constant>production</constant> der Datei
  118. <filename>application/configs/application.ini</filename> hinzuzufügen:
  119. </para>
  120. <programlisting language="ini"><![CDATA[
  121. ; application/configs/application.ini
  122. ; Zum Abschnitt [production] hinzufügen:
  123. resources.view[] =
  124. ]]></programlisting>
  125. <para>
  126. Das sagt uns das die View ohne Optionen initialisiert werden soll ('[]' zeigt das der "view"
  127. Schlüssel ein Array ist, und wir Ihm nichts übergeben).
  128. </para>
  129. <para>
  130. Jetzt da wir die View haben, sehen wir uns die <methodname>_initDoctype()</methodname>
  131. Methode an. In Ihr stellen wir zuerst sicher das die <classname>View</classname> Ressource
  132. läuft, holen das View Objekt und konfigurieren es anschließend:
  133. </para>
  134. <programlisting language="php"><![CDATA[
  135. // application/Bootstrap.php
  136. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  137. {
  138. protected function _initDoctype()
  139. {
  140. $this->bootstrap('view');
  141. $view = $this->getResource('view');
  142. $view->doctype('XHTML1_STRICT');
  143. }
  144. }
  145. ]]></programlisting>
  146. <para>
  147. Jetzt da wir <classname>Zend_Layout</classname> initialisiert und den DocType gesetzt haben
  148. erstellen wir unser Site-weites Layout:
  149. </para>
  150. <programlisting language="php"><![CDATA[
  151. <!-- application/layouts/scripts/layout.phtml -->
  152. <?php echo $this->doctype() ?>
  153. <html xmlns="http://www.w3.org/1999/xhtml">
  154. <head>
  155. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  156. <title>Zend Framework Schnellstart Anwendung</title>
  157. <?php echo $this->headLink()->appendStylesheet('/css/global.css') ?>
  158. </head>
  159. <body>
  160. <div id="header" style="background-color: #EEEEEE; height: 30px;">
  161. <div id="header-logo" style="float: left">
  162. <b>ZF Schnellstart Anwendung</b>
  163. </div>
  164. <div id="header-navigation" style="float: right">
  165. <a href="<?php echo $this->url(
  166. array('controller'=>'guestbook'),
  167. 'default',
  168. true) ?>">Guestbook</a>
  169. </div>
  170. </div>
  171. <?php echo $this->layout()->content ?>
  172. </body>
  173. </html>
  174. ]]></programlisting>
  175. <para>
  176. Wir holen den Inhalt der Anwendung indem der <methodname>layout()</methodname> View Helfer
  177. verwendet, und auf den "content" Schlüssel zugegriffen wird. Man kann andere Antwort
  178. Segmente darstellen wenn man das möchte, aber in den meisten Fällen ist das alles was
  179. notwendig ist.
  180. </para>
  181. <para>
  182. Es ist zu beachten das wir auch den <methodname>headLink()</methodname> Platzhalter
  183. verwenden. Das ist ein einfacher Weg um das <acronym>HTML</acronym> für das &lt;link&gt;
  184. Element zu erstellen, sowie um es durch die Anwendung hindurch zu verfolgen. Wenn man
  185. zusätzliche CSS Blätter zur Unterstützung einer einzelnen Aktion benötigt, kann das getan
  186. werden indem man sicherstellt das Sie in der endgültig dargestellten Seite vorhanden sind.
  187. </para>
  188. <note>
  189. <title>Checkpoint</title>
  190. <para>
  191. Jetzt gehen wir zu "http://localhost" und prüfen die Quelle. Man sieht den XHTML Header,
  192. Kopf, Titel und Body Abschnitte.
  193. </para>
  194. </note>
  195. </sect1>