Zend_Layout-QuickStart.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.layout.quickstart">
  5. <title>Zend_Layout - Démarrage rapide</title>
  6. <para>
  7. Il y a deux modes d'utilisation de <classname>Zend_Layout</classname> : avec Zend
  8. Framework <acronym>MVC</acronym>, et sans.
  9. </para>
  10. <sect2 id="zend.layout.quickstart.layouts">
  11. <title>Scripts de layout</title>
  12. <para>
  13. Dans tous les cas, un script de layout est nécessaire. Les scripts de layout
  14. utilisent simplement Zend_View (ou une implémentation particulière personnalisée). Les
  15. variables de layout sont enregistrées dans le <link
  16. linkend="zend.view.helpers.initial.placeholder">placeholder</link> <code>Layout</code>,
  17. et peuvent être accédées via l'aide de vue placeholder ou directement en tant que
  18. propriétés de l'objet layout.
  19. </para>
  20. <para>Par exemple :</para>
  21. <programlisting language="php"><![CDATA[
  22. <!DOCTYPE html
  23. PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  24. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  25. <html>
  26. <head>
  27. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  28. <title>Mon Site</title>
  29. </head>
  30. <body>
  31. <?php
  32. // récupère la clé "content" via l'aide de vue layout :
  33. echo $this->layout()->content;
  34. // récupère la clé "foo" via l'aide de vue placeholder :
  35. echo $this->placeholder('Zend_Layout')->foo;
  36. // récupère l'objet layout, et accède à diverses clés :
  37. $layout = $this->layout();
  38. echo $layout->bar;
  39. echo $layout->baz;
  40. ?>
  41. </body>
  42. </html>
  43. ]]></programlisting>
  44. <para>
  45. Toutes les aides de vue enregistrées sont accessibles dans
  46. <classname>Zend_Layout</classname> car il utilise <classname>Zend_View</classname> pour
  47. son propre rendu. Vous pouvez aussi accéder aux variables de la vue. Les aides <link
  48. linkend="zend.view.helpers.initial.placeholder">placeholder </link> sont très pratiques
  49. pour l'accès aux éléments tels que &lt;head&gt;, les scripts, les méta, etc. :
  50. </para>
  51. <programlisting language="php"><![CDATA[
  52. <!DOCTYPE html
  53. PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  54. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  55. <html>
  56. <head>
  57. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  58. <?php echo $this->headTitle() ?>
  59. <?php echo $this->headScript() ?>
  60. <?php echo $this->headStyle() ?>
  61. </head>
  62. <body>
  63. <?php echo $this->render('header.phtml') ?>
  64. <div id="nav"><?php echo $this->placeholder('nav') ?></div>
  65. <div id="content"><?php echo $this->layout()->content ?></div>
  66. <?php echo $this->render('footer.phtml') ?>
  67. </body>
  68. </html>
  69. ]]></programlisting>
  70. </sect2>
  71. <sect2 id="zend.layout.quickstart.mvc">
  72. <title>Utilisation de Zend_Layout avec le système MVC de Zend Framework</title>
  73. <para>
  74. <classname>Zend_Controller</classname> propose une manière d'étendre ses
  75. fonctionnalités au travers de <link linkend="zend.controller.plugins">plugins de
  76. contrôleur frontal</link> et <link linkend="zend.controller.actionhelpers">d'aides
  77. d'action</link>. <classname>Zend_View</classname> propose aussi des <link
  78. linkend="zend.view.helpers">aides</link>. <classname>Zend_Layout</classname> utilise
  79. toutes ces possibilités lorsqu'employé avec les composants <acronym>MVC</acronym>.
  80. </para>
  81. <para>
  82. <methodname>Zend_Layout::startMvc()</methodname> crée une instance de
  83. <classname>Zend_Layout</classname> avec des paramètres de configuration optionnels.
  84. Cette méthode enregistre aussi un plugin de contrôleur frontal qui s'occupe du rendu du
  85. layout rempli, lorsque la boucle de distribution est terminée. Elle enregistre également
  86. une aide d'action qui permet aux actions d'accéder à l'objet <code>layout</code>. Enfin,
  87. l'aide de vue layout, elle, donne accès à l'objet layout depuis la vue.
  88. </para>
  89. <para>
  90. Regardons d'abord comment initialiser Zend_Layout afin de l'utiliser dans un
  91. contexte <acronym>MVC</acronym>
  92. </para>
  93. <programlisting language="php"><![CDATA[
  94. // Dans le fichier de démarrage (bootstrap)
  95. Zend_Layout::startMvc();
  96. ]]></programlisting>
  97. <para>
  98. <methodname>startMvc()</methodname> peut prendre en paramètre un tableau d'options ou un objet
  99. <classname>Zend_Config</classname> pour personnaliser l'instance. Ces options sont
  100. détaillées dans <xref linkend="zend.layout.options" />.
  101. </para>
  102. <para>
  103. Dans le contrôleur d'action, vous pouvez donc accéder à l'instance de layout via
  104. l'aide d'action :
  105. </para>
  106. <programlisting language="php"><![CDATA[
  107. class FooController extends Zend_Controller_Action
  108. {
  109. public function barAction()
  110. {
  111. // désactive les layouts pour cette action
  112. $this->_helper->layout->disableLayout();
  113. }
  114. public function bazAction()
  115. {
  116. // utilise un script de layout différent pour
  117. // cette action
  118. $this->_helper->layout->setLayout('foobaz');
  119. };
  120. }
  121. ]]></programlisting>
  122. <para>
  123. Dans vos scripts de vue, utiliser l'aide <code>layout</code> pour accéder à
  124. l'instance de <classname>Zend_Layout</classname>. Notez que cette aide est différente
  125. des autres car elle ne retourne pas une chaîne, mais bien un objet. Vous pouvez donc
  126. enchaîner une méthode immédiatement :
  127. </para>
  128. <programlisting language="php"><![CDATA[
  129. $this->layout()->setLayout('foo'); // utilise un script de layout spécifique
  130. ]]></programlisting>
  131. <para>
  132. Autrement, vous pouvez n'importe où accéder à votre instance de
  133. <classname>Zend_Layout</classname> via la méthode statique <methodname>getMvcInstance()</methodname>
  134. :
  135. </para>
  136. <programlisting language="php"><![CDATA[
  137. // Retourne null si startMvc() n'a pas été appelée auparavant
  138. $layout = Zend_Layout::getMvcInstance();
  139. ]]></programlisting>
  140. <para>
  141. Enfin, le plugin de contrôleur frontal <classname>Zend_Layout</classname> dispose
  142. d'une caractéristique annexe au rendu automatique du layout : il analyse les segments de
  143. l'objet de réponse et les assigne en tant que variables de layout dans vos scripts de
  144. layout. Le segment "default" est assigné à la variable "content". Ceci permet de mettre
  145. la main sur le contenu rendu dans l'action principale.
  146. </para>
  147. <para>
  148. Par exemple, supposons que votre code rencontre d'abord
  149. <methodname>FooController::indexAction()</methodname>, qui va rendre du contenu dans le segment par
  150. défaut de la réponse. Ensuite il forward vers <methodname>NavController::menuAction()</methodname>,
  151. qui rend son contenu dans un segment nommé 'nav'. Enfin, vous forwardez vers
  152. <methodname>CommentController::fetchAction()</methodname> pour récupérer des commentaires, mais vous
  153. les rendez aussi dans le segment par défaut de la réponse (ce qui va rajouter du
  154. contenu). Votre script de layout peut alors rendre chaque segment de manière séparée
  155. :
  156. </para>
  157. <programlisting language="php"><![CDATA[
  158. <body>
  159. <!-- rend /nav/menu -->
  160. <div id="nav"><?php echo $this->layout()->nav ?></div>
  161. <!-- rend /foo/index + /comment/fetch -->
  162. <div id="content"><?php echo $this->layout()->content ?></div>
  163. </body>
  164. ]]></programlisting>
  165. <para>
  166. Cette approche est particulièrement utile avec <link
  167. linkend="zend.controller.actionhelpers.actionstack">l'aide d'action</link> ActionStack
  168. et son <link linkend="zend.controller.plugins.standard.actionstack"> plugin</link> du
  169. même nom. Vous pouvez les utiliser pour gérer une pile d'actions et ainsi décomposer vos
  170. processus.
  171. </para>
  172. </sect2>
  173. <sect2 id="zend.layout.quickstart.standalone">
  174. <title>Utilisation de Zend_Layout en composant indépendant</title>
  175. <para>
  176. Pris indépendamment des composants <acronym>MVC</acronym>, Zend_Layout n'offre pas tout à fait les
  177. mêmes possibilités et la même flexibilité. Cependant, vous bénéficiez de deux avantages
  178. :
  179. </para>
  180. <itemizedlist>
  181. <listitem>
  182. <para>Des variables propres aux layouts.</para>
  183. </listitem>
  184. <listitem>
  185. <para>
  186. Isolation du script de layout, de son contenu issu des scripts de
  187. vue.
  188. </para>
  189. </listitem>
  190. </itemizedlist>
  191. <para>
  192. En tant que composant indépendant, instanciez un objet
  193. <classname>Zend_Layout</classname>, configurez le au moyen d'accesseurs, passez vos
  194. variables comme des propriétés de l'objet, et rendez le layout :
  195. </para>
  196. <programlisting language="php"><![CDATA[
  197. $layout = new Zend_Layout();
  198. // Spécification du chemin des scripts layout:
  199. $layout->setLayoutPath('/chemin/vers/layouts');
  200. // passage de quelques variables :
  201. $layout->content = $content;
  202. $layout->nav = $nav;
  203. // Utilisation d'un script de layout "foo" :
  204. $layout->setLayout('foo');
  205. // rendu du layout :
  206. echo $layout->render();
  207. ]]></programlisting>
  208. </sect2>
  209. <sect2 id="zend.layout.quickstart.example">
  210. <title>Layout d'exemple</title>
  211. <para>
  212. Une image valant mieux qu'un paragraphe, voyez donc celle-ci qui décrit
  213. l'utilisation :
  214. </para>
  215. <para>
  216. <inlinegraphic align="center" fileref="figures/zend.layout.quickstart.example.png"
  217. format="PNG" valign="middle" />
  218. </para>
  219. <para>
  220. Avec cette approche, vous pouvez régler vos mises en forme <acronym>CSS</acronym>. En positionnement
  221. absolu, par exemple, vous pourriez rendre la barre de navigation plus tard, en fin. Le
  222. mécanisme d'obtention du contenu reste le même cependant.
  223. </para>
  224. </sect2>
  225. </sect1>