Introduction
Zend_Application
Programmer's Reference Guide

Zend_Application démarrage rapide

Il existe deux manières d'aborder Zend_Application, elles dépendent de la manière dont vous commencez votre projet. Dans tous les cas, vous devrez créer une classe Bootstrap et un fichier de configuration.

Si vous souhaitez utiliser Zend_Tool pour créer votre projet, continuez votre lecture. Si vous ajoutez Zend_Application à un projet existant, vous devriez passer à la suite.

Utiliser Zend_Tool

La manière la plus rapide d'utiliser Zend_Application est d'appeler Zend_Tool pour créer votre projet. Ceci va aussi créer la classe de Bootstrap.

Pour créer un projet, éxecutez la commande zf (sur les systèmes *nix) :

  1. % zf create project newproject

Pour Windows, zf.bat:

  1. C:> zf.bat create project newproject

Ceci va créer une structure de projet ressemblant à:

  1. newproject
  2. |-- application
  3. |   |-- Bootstrap.php
  4. |   |-- configs
  5. |   |   `-- application.ini
  6. |   |-- controllers
  7. |   |   |-- ErrorController.php
  8. |   |   `-- IndexController.php
  9. |   |-- models
  10. |   `-- views
  11. |       |-- helpers
  12. |       `-- scripts
  13. |           |-- error
  14. |           |   `-- error.phtml
  15. |           `-- index
  16. |               `-- index.phtml
  17. |-- library
  18. |-- public
  19. |   `-- index.php
  20. `-- tests
  21.     |-- application
  22.     |   `-- bootstrap.php
  23.     |-- library
  24.     |   `-- bootstrap.php
  25.     `-- phpunit.xml

Dans une telle structure, le bootstrap est newproject/application/Bootstrap.php, et ressemble en premier lieux à ceci:

  1. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  2. {
  3. }

Notez aussi la présence d'un fichier de configuration newproject/application/configs/application.ini, il contient :

  1. [production]
  2. phpSettings.display_startup_errors = 0
  3. phpSettings.display_errors = 0
  4. includePaths.library = APPLICATION_PATH "/../library"
  5. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  6. bootstrap.class = "Bootstrap"
  7. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  8.  
  9. [staging : production]
  10.  
  11. [testing : production]
  12. phpSettings.display_startup_errors = 1
  13. phpSettings.display_errors = 1
  14.  
  15. [development : production]
  16. phpSettings.display_startup_errors = 1
  17. phpSettings.display_errors = 1

Tous ces paramètres s'utilisent avec Zend_Application et avec le bootstrap.

Un autre fichier intéressant est newproject/public/index.php, qui invoque Zend_Application et le démarre.

  1. // Define path to application directory
  2. defined('APPLICATION_PATH')
  3.     || define('APPLICATION_PATH',
  4.               realpath(dirname(__FILE__) . '/../application'));
  5.  
  6. // Define application environment
  7. defined('APPLICATION_ENV')
  8.     || define('APPLICATION_ENV',
  9.               (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV')
  10.                                          : 'production'));
  11.  
  12. /** Zend_Application */
  13. require_once 'Zend/Application.php';
  14.  
  15. // Create application, bootstrap, and run
  16. $application = new Zend_Application(
  17.     APPLICATION_ENV,
  18.     APPLICATION_PATH . '/configs/application.ini'
  19. );
  20. $application->bootstrap()
  21.             ->run();

Pour continuer le guide de démarrage rapide,voyez la section sur les Ressources.

Ajouter Zend_Application à votre existant

Les bases de Zend_Application sont très simples :

  • Créez un fichier application/Bootstrap.php contenant une classe Bootstrap.

  • Créez un fichier application/configs/application.ini contenant la configuration de base pour Zend_Application.

  • Modifiez public/index.php afin d'utiliser Zend_Application.

D'abord, créez la classe Bootstrap class. Dans le fichier application/Bootstrap.php, voici le contenu :

  1. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  2. {
  3. }

Créez maintenant votre configuration. Pour ce tutoriel, nous utilisons une syntaxe INI, bien sûr une syntaxe XML ou PHP est utilisable aussi. Créez donc le fichier application/configs/application.ini, et ajoutez lui ce contenu :

  1. [production]
  2. phpSettings.display_startup_errors = 0
  3. phpSettings.display_errors = 0
  4. includePaths.library = APPLICATION_PATH "/../library"
  5. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  6. bootstrap.class = "Bootstrap"
  7. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  8.  
  9. [staging : production]
  10.  
  11. [testing : production]
  12. phpSettings.display_startup_errors = 1
  13. phpSettings.display_errors = 1
  14.  
  15. [development : production]
  16. phpSettings.display_startup_errors = 1
  17. phpSettings.display_errors = 1

Maintenant, modifions le script de démarrage public/index.php. Si le fichier n'existe pas, créez le, et placez ce contenu dedans :

  1. // Define path to application directory
  2. defined('APPLICATION_PATH')
  3.     || define('APPLICATION_PATH',
  4.               realpath(dirname(__FILE__) . '/../application'));
  5.  
  6. // Define application environment
  7. defined('APPLICATION_ENV')
  8.     || define('APPLICATION_ENV',
  9.               (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV')
  10.                                          : 'production'));
  11.  
  12. // Typically, you will also want to add your library/ directory
  13. // to the include_path, particularly if it contains your ZF installed
  14. set_include_path(implode(PATH_SEPARATOR, array(
  15.     dirname(dirname(__FILE__)) . '/library',
  17. )));
  18.  
  19. /** Zend_Application */
  20. require_once 'Zend/Application.php';
  21.  
  22. // Create application, bootstrap, and run
  23. $application = new Zend_Application(
  24.     APPLICATION_ENV,
  25.     APPLICATION_PATH . '/configs/application.ini'
  26. );
  27. $application->bootstrap()
  28.             ->run();

Notez que l'environnement applicatif est défini dans une constante "APPLICATION_ENV". Nous recommandons la spécification d'un tel paramètre dans la configuration générale du serveur web. Pour Apache, vous pouvez utiliser .htaccess si votre serveur le permet. Nous recommandons un fichier public/.htaccess avec le contenu suivant :

  1. SetEnv APPLICATION_ENV development
  2.  
  3. RewriteEngine On
  4. RewriteCond %{REQUEST_FILENAME} -s [OR]
  5. RewriteCond %{REQUEST_FILENAME} -l [OR]
  6. RewriteCond %{REQUEST_FILENAME} -d
  7. RewriteRule ^.*$ - [NC,L]
  8. RewriteRule ^.*$ index.php [NC,L]

Note: Apprenez mod_rewrite
 Les règles de réécriture ci-dessus autorisent l'accès à tout fichier existant dans l'hôte virtuel. S'il existe des fichiers que vous ne voulez pas exposer, utilisez des règles plus restrictives. Le site web d'Apache » vous permettra d'en apprendre plus au sujet de mod_rewrite.

Voila, à partir de maintenant nous sommes prêts à tirer partie de la puissance de Zend_Application.

Ajouter et créer des ressources

Si vous avez suivi les instructions jusqu'à maintenant, alors votre classe de bootstrap utilisera le contrôleur frontal et lorsque lancée, lancera le dispatch du contrôleur frontal. En vérité, il va être rapidement nécessaire de rajouter de la configuration, concernant d'autres objets divers (appelés "ressources").

Nous allons voir ici comment créer et configurer des ressources. D'abord un layout, puis nous personnaliserons un objet de vue.

Une ressource assez standard proposée par Zend_Application est "layout". Cette ressource attend une configuration qu'elle fera suivre immédiatement à Zend_Layout.

Pour l'utiliser, vous devrez modifier votre fichier de configuration comme suit:

  1. [production]
  2. phpSettings.display_startup_errors = 0
  3. phpSettings.display_errors = 0
  4. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  5. bootstrap.class = "Bootstrap"
  6. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  7.  
  8. ; AJOUTEZ CES LIGNES
  9. resources.layout.layout = "layout"
  10. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  11.  
  12. [staging : production]
  13.  
  14. [testing : production]
  15. phpSettings.display_startup_errors = 1
  16. phpSettings.display_errors = 1
  17.  
  18. [development : production]
  19. phpSettings.display_startup_errors = 1
  20. phpSettings.display_errors = 1

Si ce n'est pas déja fait, créez le dossier application/layouts/scripts/, et le fichier layout.phtml dans ce même dossier. Voici un exemple de script de layout tout à fait classique:

  1. <?php echo $this->doctype() ?>
  2. <html>
  3. <head>
  4.     <?php echo $this->headTitle() ?>
  5.     <?php echo $this->headLink() ?>
  6.     <?php echo $this->headStyle() ?>
  7.     <?php echo $this->headScript() ?>
  8. </head>
  9. <body>
  10.     <?php echo $this->layout()->content ?>
  11. </body>
  12. </html>

Voila, vous avez un layout fonctionnel.

Maintenant passons à la vue. Nous voulons un DocType HTML et une valeur de titre par défaut à utiliser dans la partie "head" du HTML. Nous pouvons ordonner ceci en éditant la classe Bootstrap et en ajoutant une méthode.

  1. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  2. {
  3.     protected function _initView()
  4.     {
  5.         // Initialisons la vue
  6.         $view = new Zend_View();
  7.         $view->doctype('XHTML1_STRICT');
  8.         $view->headTitle('My First Zend Framework Application');
  9.  
  10.         // Ajoutons là au ViewRenderer
  11.         $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
  12.             'ViewRenderer'
  13.         );
  14.         $viewRenderer->setView($view);
  15.  
  16.         // Retourner la vue pour qu'elle puisse être stockée par le bootstrap
  17.         return $view;
  18.     }
  19. }

Cette méthode va être lancée automatiquement lors du bootstrap et configurera une vue.

Aller plus loin avec Zend_Application

Nous vennons de voir comment configurer de manière basique Zend_Application ainsi que les principes du bootstrap. Pour un maximum de réutilisation de code, vous devriez songer à utiliser des plugins de ressources. Continuez à lire la suite !

Introduction
Zend_Application
Programmer's Reference Guide