Zend_Application-QuickStart.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.application.quick-start">
  4. <title>Zend_Application démarrage rapide</title>
  5. <para>
  6. Il existe deux manières d'aborder
  7. <classname>Zend_Application</classname>, elles dépendent de la manière dont vous commencez
  8. votre projet. Dans tous les cas, vous devrez créer une classe
  9. <classname>Bootstrap</classname> et un fichier de configuration.
  10. </para>
  11. <para>
  12. Si vous souhaitez utiliser <classname>Zend_Tool</classname> pour créer votre projet,
  13. continuez votre lecture. Si vous ajoutez
  14. <classname>Zend_Application</classname> à un projet existant, vous devriez
  15. <link linkend="zend.application.quick-start.manual">passer à la suite</link>.
  16. </para>
  17. <sect2 id="zend.application.quick-start.zend-tool">
  18. <title>Utiliser Zend_Tool</title>
  19. <para>
  20. La manière la plus rapide d'utiliser <classname>Zend_Application</classname> est d'appeler
  21. <classname>Zend_Tool</classname> pour créer votre projet. Ceci va aussi créer la classe de
  22. <classname>Bootstrap</classname>.
  23. </para>
  24. <para>
  25. Pour créer un projet, éxecutez la commande <command>zf</command> (sur les systèmes *nix):
  26. </para>
  27. <programlisting language="sh"><![CDATA[
  28. % zf create project newproject
  29. ]]></programlisting>
  30. <para>
  31. Pour Windows, <filename>zf.bat</filename>:
  32. </para>
  33. <programlisting language="dos"><![CDATA[
  34. C:> zf.bat create project newproject
  35. ]]></programlisting>
  36. <para>
  37. Ceci va créer une structure de projet ressemblant à:
  38. </para>
  39. <programlisting language="text"><![CDATA[
  40. newproject
  41. |-- application
  42. | |-- Bootstrap.php
  43. | |-- configs
  44. | | `-- application.ini
  45. | |-- controllers
  46. | | |-- ErrorController.php
  47. | | `-- IndexController.php
  48. | |-- models
  49. | `-- views
  50. | |-- helpers
  51. | `-- scripts
  52. | |-- error
  53. | | `-- error.phtml
  54. | `-- index
  55. | `-- index.phtml
  56. |-- library
  57. |-- public
  58. | `-- index.php
  59. `-- tests
  60. |-- application
  61. | `-- bootstrap.php
  62. |-- library
  63. | `-- bootstrap.php
  64. `-- phpunit.xml
  65. ]]></programlisting>
  66. <para>
  67. Dans une telle structure, le bootstrap est
  68. <filename>newproject/application/Bootstrap.php</filename>, et ressemble
  69. en premier lieux à ceci:
  70. </para>
  71. <programlisting language="php"><![CDATA[
  72. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  73. {
  74. }
  75. ]]></programlisting>
  76. <para>
  77. Notez aussi la présence d'un fichier de configuration
  78. <filename>newproject/application/configs/application.ini</filename>, il contient:
  79. </para>
  80. <programlisting language="dosini"><![CDATA[
  81. [production]
  82. phpSettings.display_startup_errors = 0
  83. phpSettings.display_errors = 0
  84. includePaths.library = APPLICATION_PATH "/../library"
  85. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  86. bootstrap.class = "Bootstrap"
  87. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  88. [staging : production]
  89. [testing : production]
  90. phpSettings.display_startup_errors = 1
  91. phpSettings.display_errors = 1
  92. [development : production]
  93. phpSettings.display_startup_errors = 1
  94. phpSettings.display_errors = 1
  95. ]]></programlisting>
  96. <para>
  97. Tous ces paramètres s'utilisent avec
  98. <classname>Zend_Application</classname> et avec le bootstrap.
  99. </para>
  100. <para>
  101. Un autre fichier intéressant est
  102. <filename>newproject/public/index.php</filename>, qui invoque
  103. <classname>Zend_Application</classname> et le démarre.
  104. </para>
  105. <programlisting language="php"><![CDATA[
  106. // Define path to application directory
  107. defined('APPLICATION_PATH')
  108. || define('APPLICATION_PATH',
  109. realpath(dirname(__FILE__) . '/../application'));
  110. // Define application environment
  111. defined('APPLICATION_ENV')
  112. || define('APPLICATION_ENV',
  113. (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV')
  114. : 'production'));
  115. /** Zend_Application */
  116. require_once 'Zend/Application.php';
  117. // Create application, bootstrap, and run
  118. $application = new Zend_Application(
  119. APPLICATION_ENV,
  120. APPLICATION_PATH . '/configs/application.ini'
  121. );
  122. $application->bootstrap()
  123. ->run();
  124. ]]></programlisting>
  125. <para>
  126. Pour continuer le guide de démarrage rapide,<link
  127. linkend="zend.application.quick-start.resources">voyez la section sur les
  128. Ressources</link>.
  129. </para>
  130. </sect2>
  131. <sect2 id="zend.application.quick-start.manual">
  132. <title>Ajouter Zend_Application à votre existant</title>
  133. <para>
  134. Les bases de <classname>Zend_Application</classname> sont très simples:
  135. </para>
  136. <itemizedlist>
  137. <listitem><para>
  138. Créez un fichier <filename>application/Bootstrap.php</filename> contenant une classe
  139. <classname>Bootstrap</classname>.
  140. </para></listitem>
  141. <listitem><para>
  142. Créez un fichier <filename>application/configs/application.ini</filename>
  143. contenant la configuration de base pour <classname>Zend_Application</classname>.
  144. </para></listitem>
  145. <listitem><para>
  146. Modifiez <filename>public/index.php</filename> afin d'utiliser
  147. <classname>Zend_Application</classname>.
  148. </para></listitem>
  149. </itemizedlist>
  150. <para>
  151. D'abord, créez la classe <classname>Bootstrap</classname> class. Dans le fichier
  152. <filename>application/Bootstrap.php</filename>, voici le contenu:
  153. </para>
  154. <programlisting language="php"><![CDATA[
  155. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  156. {
  157. }
  158. ]]></programlisting>
  159. <para>
  160. Créez maintenant votre configuration. Pour ce tutoriel, nous utilisons une syntaxe
  161. <acronym>INI</acronym>, bien sûr une syntaxe <acronym>XML</acronym> ou
  162. <acronym>PHP</acronym> est utilisable aussi. Créez donc le fichier
  163. <filename>application/configs/application.ini</filename>, et ajoutez lui ce contenu:
  164. </para>
  165. <programlisting language="dosini"><![CDATA[
  166. [production]
  167. phpSettings.display_startup_errors = 0
  168. phpSettings.display_errors = 0
  169. includePaths.library = APPLICATION_PATH "/../library"
  170. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  171. bootstrap.class = "Bootstrap"
  172. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  173. [staging : production]
  174. [testing : production]
  175. phpSettings.display_startup_errors = 1
  176. phpSettings.display_errors = 1
  177. [development : production]
  178. phpSettings.display_startup_errors = 1
  179. phpSettings.display_errors = 1
  180. ]]></programlisting>
  181. <para>
  182. Maintenant, modifions le script de démarrage
  183. <filename>public/index.php</filename>. Si le fichier n'existe pas, créez le, et placez ce contenu dedans:
  184. </para>
  185. <programlisting language="php"><![CDATA[
  186. // Define path to application directory
  187. defined('APPLICATION_PATH')
  188. || define('APPLICATION_PATH',
  189. realpath(dirname(__FILE__) . '/../application'));
  190. // Define application environment
  191. defined('APPLICATION_ENV')
  192. || define('APPLICATION_ENV',
  193. (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV')
  194. : 'production'));
  195. // Typically, you will also want to add your library/ directory
  196. // to the include_path, particularly if it contains your ZF installed
  197. set_include_path(implode(PATH_SEPARATOR, array(
  198. dirname(dirname(__FILE__)) . '/library',
  199. get_include_path(),
  200. )));
  201. /** Zend_Application */
  202. require_once 'Zend/Application.php';
  203. // Create application, bootstrap, and run
  204. $application = new Zend_Application(
  205. APPLICATION_ENV,
  206. APPLICATION_PATH . '/configs/application.ini'
  207. );
  208. $application->bootstrap()
  209. ->run();
  210. ]]></programlisting>
  211. <para>
  212. Notez que l'environnement applicatif est défini dans une constante
  213. "APPLICATION_ENV". Nous recommandons la spécification d'un tel paramètre dans la configuration
  214. générale du serveur web. Pour Apache, vous pouvez utiliser <filename>.htaccess</filename>
  215. si votre serveur le permet. Nous recommandons un fichier <filename>public/.htaccess</filename>
  216. avec le contenu suivant:
  217. </para>
  218. <programlisting language="conf"><![CDATA[
  219. SetEnv APPLICATION_ENV development
  220. RewriteEngine On
  221. RewriteCond %{REQUEST_FILENAME} -s [OR]
  222. RewriteCond %{REQUEST_FILENAME} -l [OR]
  223. RewriteCond %{REQUEST_FILENAME} -d
  224. RewriteRule ^.*$ - [NC,L]
  225. RewriteRule ^.*$ index.php [NC,L]
  226. ]]></programlisting>
  227. <note>
  228. <title>Apprenez mod_rewrite</title>
  229. <para>
  230. Les règles de réécriture ci-dessus autorisent l'accès à tout fichier existant
  231. dans l'hôte virtuel. S'il existe des fichiers que vous ne voulez pas exposer, utilisez
  232. des règles plus restrictives. Le site web d'Apache <ulink
  233. url="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html">vous permettra d'en apprendre
  234. plus au sujet de mod_rewrite</ulink>.
  235. </para>
  236. </note>
  237. <para>
  238. Voila, à partir de maintenant nous sommes prêts à tirer partie de la puissance de
  239. <classname>Zend_Application</classname>.
  240. </para>
  241. </sect2>
  242. <sect2 id="zend.application.quick-start.resources">
  243. <title>Ajouter et créer des ressources</title>
  244. <para>
  245. Si vous avez suivi les instructions jusqu'à maintenant, alors votre classe de
  246. bootstrap utilisera le contrôleur frontal et lorsque lancée, lancera le dispatch
  247. du contrôleur frontal. En vérité, il va être rapidement nécessaire de rajouter de
  248. la configuration, concernant d'autres objets divers (appelés "ressources").
  249. </para>
  250. <para>
  251. Nous allons voir ici comment créer et configurer des ressources. D'abord un layout,
  252. puis nous personnaliserons un objet de vue.
  253. </para>
  254. <para>
  255. Une ressource assez standard proposée par
  256. <classname>Zend_Application</classname> est "layout". Cette ressource attend
  257. une configuration qu'elle fera suivre immédiatement à
  258. <classname>Zend_Layout</classname>.
  259. </para>
  260. <para>
  261. Pour l'utiliser, vous devrez modifier votre fichier de configuration comme suit:
  262. </para>
  263. <programlisting language="dosini"><![CDATA[
  264. [production]
  265. phpSettings.display_startup_errors = 0
  266. phpSettings.display_errors = 0
  267. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  268. bootstrap.class = "Bootstrap"
  269. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  270. ; AJOUTEZ CES LIGNES
  271. resources.layout.layout = "layout"
  272. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  273. [staging : production]
  274. [testing : production]
  275. phpSettings.display_startup_errors = 1
  276. phpSettings.display_errors = 1
  277. [development : production]
  278. phpSettings.display_startup_errors = 1
  279. phpSettings.display_errors = 1
  280. ]]></programlisting>
  281. <para>
  282. Si ce n'est pas déja fait, créez le dossier
  283. <filename>application/layouts/scripts/</filename>, et le fichier
  284. <filename>layout.phtml</filename> dans ce même dossier. Voici un exemple de script
  285. de layout tout à fait classique:
  286. </para>
  287. <programlisting language="php"><![CDATA[
  288. <?php echo $this->doctype() ?>
  289. <html>
  290. <head>
  291. <?php echo $this->headTitle() ?>
  292. <?php echo $this->headLink() ?>
  293. <?php echo $this->headStyle() ?>
  294. <?php echo $this->headScript() ?>
  295. </head>
  296. <body>
  297. <?php echo $this->layout()->content ?>
  298. </body>
  299. </html>
  300. ]]></programlisting>
  301. <para>
  302. Voila, vous avez un layout fonctionnel.
  303. </para>
  304. <para>
  305. Maintenant passons à la vue. Nous voulons un DocType <acronym>HTML</acronym> et
  306. une valeur de titre par défaut à utiliser dans la partie "head". Nous pouvons
  307. ordonner ceci en éditant la classe
  308. <classname>Bootstrap</classname> et en ajoutant une méthode
  309. </para>
  310. <programlisting language="php"><![CDATA[
  311. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  312. {
  313. protected function _initView()
  314. {
  315. // Initialisons la view
  316. $view = new Zend_View();
  317. $view->doctype('XHTML1_STRICT');
  318. $view->headTitle('My First Zend Framework Application');
  319. // Ajoutons la au ViewRenderer
  320. $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
  321. 'ViewRenderer'
  322. );
  323. $viewRenderer->setView($view);
  324. // Retourner la vue pour qu'elle puisse être stockée par le bootstrap
  325. return $view;
  326. }
  327. }
  328. ]]></programlisting>
  329. <para>
  330. Cette méthode va être lancée automatiquement lors du bootstrap et configurera une vue.
  331. </para>
  332. </sect2>
  333. <sect2 id="zend.application.quick-start.next-steps">
  334. <title>Aller plus loin avec Zend_Application</title>
  335. <para>
  336. Nous vennons de voir comment configurer de manière basique <classname>Zend_Application</classname>
  337. ainsi que les principes du bootstrap. Pour un maximum de réutilisation de code, vous devriez
  338. songer à utiliser des plugins de ressources. Continuez à lire la suite!
  339. </para>
  340. </sect2>
  341. </sect1>