quickstart-create-layout.xml 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20977 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="learning.quickstart.create-layout">
  5. <title>Utworzenie layoutu</title>
  6. <para>
  7. Jak nie trudno zauważyć, skrypty widoków z poprzedniej części zawierały jedynie fragmenty
  8. kodu HTML a nie całe strony. Jest to intencjonalne i ma na celu przygotowanie akcji tak aby
  9. zwracały jedynie zawartość związaną z samą akcją a nie aplikacją jako taką.
  10. </para>
  11. <para>
  12. Teraz należy umieścić generowaną treść w pełnoprawnej stronie HTML. Przydatne jest również
  13. nadanie całej aplikacji jednolitego, zwięzłego wyglądu. Aby to osiągnąć zostanie użyty
  14. globalny layout (wzór) strony.
  15. </para>
  16. <para>
  17. Zend Framework używa dwóch wzorów projektowych przy implementacji layoutów: <ulink
  18. url="http://martinfowler.com/eaaCatalog/twoStepView.html">Widok dwustopniowy (Two Step View)</ulink> and
  19. <ulink
  20. url="http://java.sun.com/blueprints/corej2eepatterns/Patterns/CompositeView.html">Widok
  21. złożony (Composite View)</ulink>.
  22. <emphasis>Widok dwustopniowy</emphasis> jest najczęściej powiązany z <ulink
  23. url="http://www.martinfowler.com/eaaCatalog/transformView.html">Widokiem przekształconym
  24. (Transform View)</ulink> - podstawową cechą jest założenie, że aplikacja tworzy widok
  25. podrzędny, który zostaje umieszczony w widoku głównym (layout) i dopiero taki - złożony
  26. widok jest przetwarzany do pokazania użytkownikowi.
  27. <emphasis>Widok złożony</emphasis> natomiast, zakłada tworzenie jednego bądź wielu
  28. autonomicznych widoków bez relacji rodzic-potomek.
  29. </para>
  30. <para>
  31. <link linkend="zend.layout">Zend_Layout</link> jest komponentem, który łączy te wzorce w
  32. aplikacji Zend Framework. Każdy skrypt widoku (view script) posiada własne elementy i
  33. nie musi zajmować się wyświetlaniem elementów wspólnych dla całej strony.
  34. </para>
  35. <para>
  36. Mogą powstać sytuacje, w których niezbędne okaże się umieszczenie globalnych elementów w
  37. pojedynczym widoku. W tym celu Zend Framework udostępnia szereg
  38. <emphasis>pojemników (placeholders)</emphasis>, które umożliwiają dostęp do takich
  39. elementów z poziomu lokalnego skryptu widoku.
  40. </para>
  41. <para>
  42. Aby rozpocząć korzystanie z Zend_Layout należy najpierw poinstruować bootstrap aby
  43. włączył zasób <classname>Layout</classname>. Można to osiągnąć za pomocą komendy
  44. <command>zf enable layout</command> (w katalogu tworzonego projektu):
  45. </para>
  46. <programlisting language="shell"><![CDATA[
  47. % zf enable layout
  48. Layouts have been enabled, and a default layout created at
  49. application/layouts/scripts/layout.phtml
  50. A layout entry has been added to the application config file.
  51. ]]></programlisting>
  52. <para>
  53. Tak jak jest to napisane w potwierdzeniu komendy, plik
  54. <filename>application/configs/application.ini</filename> został zaktualizowany i
  55. zawiera następujący wpis w sekcji <constant>production</constant>:
  56. </para>
  57. <programlisting language="ini"><![CDATA[
  58. ; application/configs/application.ini
  59. ; Dodane do sekcji [production]:
  60. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  61. ]]></programlisting>
  62. <para>
  63. W rezultacie plik INI powinien wyglądać następująco:
  64. </para>
  65. <programlisting language="ini"><![CDATA[
  66. ; application/configs/application.ini
  67. [production]
  68. phpSettings.display_startup_errors = 0
  69. phpSettings.display_errors = 0
  70. includePaths.library = APPLICATION_PATH "/../library"
  71. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  72. bootstrap.class = "Bootstrap"
  73. appnamespace = "Application"
  74. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  75. resources.frontController.params.displayExceptions = 0
  76. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  77. [staging : production]
  78. [testing : production]
  79. phpSettings.display_startup_errors = 1
  80. phpSettings.display_errors = 1
  81. [development : production]
  82. phpSettings.display_startup_errors = 1
  83. phpSettings.display_errors = 1
  84. ]]></programlisting>
  85. <para>
  86. Dodany zapis powoduje, że aplikacja szuka skryptów widoku w katalogu
  87. <filename>application/layouts/scripts</filename>.
  88. Należy zauważyć, iż taki katalog wraz z plikiem <filename>layout.phtml</filename>
  89. zostały utworzone w strukturze projektu przez narzędzie wiersza poleceń zf.
  90. </para>
  91. <para>
  92. Następną przydatną rzeczą będzie upewnienie się, że deklaracja XHTML DocType jest
  93. umieszczona i poprawnie sformułowana. Aby to osiągnąć należy dodać zasób do bootstrapa.
  94. </para>
  95. <para>
  96. Najprostszym sposobem na dodanie zasobu bootstrap jest utworzenie chronionej metody o
  97. nazwie zaczynającej się na <methodname>_init</methodname>. Celem jest zainicjalizowanie
  98. deklaracji DocType więc nowa metoda w klasie bootstrap może się nazywać
  99. <methodname>_initDoctype()</methodname>:
  100. </para>
  101. <programlisting language="php"><![CDATA[
  102. // application/Bootstrap.php
  103. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  104. {
  105. protected function _initDoctype()
  106. {
  107. }
  108. }
  109. ]]></programlisting>
  110. <para>
  111. W ciele metody należy powiadomić zasób widoku aby użył odpowiedni DocType. Tylko skąd
  112. wziąć obiekt widoku? Najłatwiejszym rozwiązaniem jest zainicjalizowanie zasobu
  113. <classname>View</classname>. Potem można pobrać obiekt i go użyć.
  114. </para>
  115. <para>
  116. Aby zainicjalizować zasób widoku należy dodać następującą linijkę do pliku
  117. <filename>application/configs/application.ini</filename> w sekcji
  118. <constant>production</constant>:
  119. </para>
  120. <programlisting language="ini"><![CDATA[
  121. ; application/configs/application.ini
  122. ; Dodanie do sekcji [production]:
  123. resources.view[] =
  124. ]]></programlisting>
  125. <para>
  126. Ten zapis inicjalizuje widok bez żadnych opcji (pisownia '[]' oznacza, że "view" jest
  127. tablicą bez żadnych kluczy ani wartości).
  128. </para>
  129. <para>
  130. Teraz, skoro widok jest skonfigurowany, można wrócić do metody
  131. <methodname>_initDoctype()</methodname>.
  132. W niej należy upewnić się, że zasób <classname>View</classname> został zainicjowany (na
  133. podstawie zapisów w pliku konfiguracyjnym), pobrać obiekt widoku i go skonfigurować:
  134. </para>
  135. <programlisting language="php"><![CDATA[
  136. // application/Bootstrap.php
  137. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  138. {
  139. protected function _initDoctype()
  140. {
  141. $this->bootstrap('view');
  142. $view = $this->getResource('view');
  143. $view->doctype('XHTML1_STRICT');
  144. }
  145. }
  146. ]]></programlisting>
  147. <para>
  148. Po zainicjalizowaniu <classname>Zend_Layout</classname> i ustawieniu deklaracji Doctype,
  149. należy utworzyć główny layout strony:
  150. </para>
  151. <programlisting language="php"><![CDATA[
  152. <!-- application/layouts/scripts/layout.phtml -->
  153. <?php echo $this->doctype() ?>
  154. <html xmlns="http://www.w3.org/1999/xhtml">
  155. <head>
  156. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  157. <title>Zend Framework Quickstart Application</title>
  158. <?php echo $this->headLink()->appendStylesheet('/css/global.css') ?>
  159. </head>
  160. <body>
  161. <div id="header" style="background-color: #EEEEEE; height: 30px;">
  162. <div id="header-logo" style="float: left">
  163. <b>ZF Quickstart Application</b>
  164. </div>
  165. <div id="header-navigation" style="float: right">
  166. <a href="<?php echo $this->url(
  167. array('controller'=>'guestbook'),
  168. 'default',
  169. true) ?>">Guestbook</a>
  170. </div>
  171. </div>
  172. <?php echo $this->layout()->content ?>
  173. </body>
  174. </html>
  175. ]]></programlisting>
  176. <para>
  177. Za pomocą view helpera <methodname>layout()</methodname> pobierana jest zawartość
  178. przeznaczona do wyświetlenia (znajduje się w zmiennej "content"). Można ją umieszczać w
  179. innych częściach layoutu ale w większości przypadków takie podejście wystarczy.
  180. </para>
  181. <para>
  182. Należy zwrócić uwagę na użycie view helpera <methodname>headLink()</methodname>. Jest to
  183. prosty sposób na zachowanie kontroli nad elementami &lt;link&gt; dodawanymi w
  184. różnych miejscach aplikacji oraz na wygenerowanie kodu HTML dla tych elementów
  185. w pliku layoutu bądź innego view scriptu.
  186. Jeśli zajdzie potrzeba dodania dodatkowego arkusza CSS w pojedynczej akcji to
  187. można to zrobić używając <methodname>headLink()</methodname>(na generowanej
  188. stronie pojawi się automatycznie).
  189. </para>
  190. <note>
  191. <title>Punkt kontrolny</title>
  192. <para>
  193. Teraz należy udać się pod adres "http://localhost" i sprawdzić efekty oraz
  194. wytworzony kod. Powinien pojawić się nagłówek XHTML, elementy head, title oraz body.
  195. </para>
  196. </note>
  197. </sect1>