Programmer's Reference Guide

Chapitre 12. Zend_Controller

Table des matières

12.1. Zend_Controller - Démarrage rapide
12.1.1. Introduction
12.1.2. Démarrage rapide
12.1.2.1. Créer votre disposition de système de fichiers
12.1.2.2. Régler votre document root
12.1.2.3. Créer vos règles de réécriture
12.1.2.4. Créer votre fichier d'amorçage (bootstrap)
12.1.2.5. Créer votre contrôleur d'action par défaut
12.1.2.6. Créer votre script de vue
12.1.2.7. Créer votre contrôleur d'erreur
12.1.2.8. Voir le site !
12.2. Fondations de Zend_Controller
12.3. Le contrôleur frontal (Front Controller)
12.3.1. Présentation générale
12.3.2. Méthodes principales
12.3.2.1. getInstance()
12.3.2.2. setControllerDirectory() et addControllerDirectory
12.3.2.3. addModuleDirectory() et getModuleDirectory()
12.3.2.4. dispatch()
12.3.2.5. run()
12.3.3. Méthodes d'accès à l'environnement
12.3.4. Paramètres du contrôleur frontal
12.3.5. Étendre le contrôleur frontal
12.4. L'objet Requête
12.4.1. Introduction
12.4.2. Les requêtes HTTP
12.4.2.1. Accéder aux données de la requête
12.4.2.2. Base de l'URL et sous-dossiers
12.4.2.3. Déterminer le type de la requête
12.4.2.4. Détecter les requêtes AJAX
12.4.3. Sous-classer l'objet Requête
12.5. Routeur Standard
12.5.1. Introduction
12.5.2. Utilisation d'un routeur
12.5.3. Utilisation basique du routeur de réécriture
12.5.4. Routes par défaut
12.5.5. Base URL et sous dossiers
12.5.6. Paramètres globaux
12.5.7. Types de route
12.5.7.1. Zend_Controller_Router_Route
12.5.7.1.1. Variables par défaut
12.5.7.1.2. Obligations et contraintes des variables
12.5.7.2. Zend_Controller_Router_Route_Static
12.5.7.3. Zend_Controller_Router_Route_Regex
12.5.7.4. Zend_Controller_Router_Route_Hostname
12.5.7.5. Zend_Controller_Router_Route_Chain
12.5.7.5.1. Chain Routes via Zend_Config
12.5.8. Utiliser Zend_Config avec le RewriteRouter
12.5.9. Dérivation de l'objet Router
12.6. Le distributeur
12.6.1. Vue d'ensemble
12.6.2. Sous-classer le distributeur
12.7. Contrôleurs d'action
12.7.1. Introduction
12.7.2. Initialisation d'objet
12.7.3. Détournement Pre et Post-Dispatch (Hook)
12.7.4. Accesseurs
12.7.5. Intégration des Vues
12.7.5.1. Initialisation des Vues
12.7.5.2. Effectuer le rendu des Vues
12.7.6. Méthodes utiles
12.7.7. Sous-classer le contrôleur d'action
12.8. Aides d'action (Helper)
12.8.1. Introduction
12.8.2. Initialisation des aides
12.8.3. Le gestionnaire d'aide (Broker)
12.8.4. Aides d'action intégrées
12.8.4.1. ActionStack
12.8.4.2. AutoComplete
12.8.4.2.1. AutoCompletion avec Dojo
12.8.4.2.2. AutoCompletion avec Scriptaculous
12.8.4.3. ContextSwitch et AjaxContext
12.8.4.3.1. Contextes inclus par défaut
12.8.4.3.2. Créer ses propres contextes
12.8.4.3.3. Affecter des contextes par action
12.8.4.3.4. Initialiser le Context Switch
12.8.4.3.5. Fonctionnalités avancées
12.8.4.3.6. Fonctionnalité AjaxContext
12.8.4.4. FlashMessenger
12.8.4.4.1. Introduction
12.8.4.4.2. Exemple d'utilisation basique
12.8.4.5. JSON
12.8.4.6. Redirector
12.8.4.6.1. Introduction
12.8.4.6.2. Exemples d'utilisation basique
12.8.4.7. ViewRenderer
12.8.4.7.1. Introduction
12.8.4.7.2. API
12.8.4.7.3. Exemples
12.8.4.7.4. Utilisation avancée
12.8.5. Écrire vos propres aides
12.9. Objet de réponse
12.9.1. Utilisation
12.9.2. Manipulation des en-têtes
12.9.3. Segments nommés
12.9.4. Manipulation des exceptions dans l'objet de réponse
12.9.5. Dériver l'objet de réponse
12.10. Plugins
12.10.1. Introduction
12.10.2. Écrire des plugins
12.10.3. Utilisation des plugins
12.10.4. Récupération et manipulations des plugins
12.10.5. Plugins inclus dans Zend Framework
12.10.5.1. ActionStack
12.10.5.2. Zend_Controller_Plugin_ErrorHandler
12.10.5.2.1. Utilisation de ErrorHandler pour gérer les erreurs 404
12.10.5.2.2. Gestion des rendus précédants de la réponse
12.10.5.2.3. Exemples d'utilisation
12.10.5.2.4. Exemple de contrôleur d'erreurs
12.11. Utilisation de conventions de dossiers modulaires
12.11.1. Introduction
12.11.2. Spécification des dossiers de modules
12.11.3. Routage des modules
12.11.4. Module ou contrôleur Default global
12.12. Exceptions avec MVC
12.12.1. Introduction
12.12.2. Gestion des exceptions
12.12.3. Différents types d'exceptions que vous pouvez rencontrer
12.13. Migrer depuis des versions précédentes
12.13.1. Migrer de la version 1.7.x vers 1.8.0 ou plus récent
12.13.1.1. Changement de la route standard
12.13.2. Migrer de la version 1.6.x vers 1.7.0 ou plus récent
12.13.2.1. Changement dans l'interface Dispatcher
12.13.3. Migrer de la version 1.5.x vers 1.6.0 ou plus récent
12.13.3.1. Changement dans l'interface Dispatcher
12.13.4. Migrer de la version 1.0.x vers 1.5.0 ou plus récent
12.13.5. Migrer de la version 0.9.3 vers 1.0.0RC1 ou plus récent
12.13.6. Migrer de la version 0.9.2 vers 0.9.3 ou plus récent
12.13.7. Migrer de la version 0.6.0 vers 0.8.0 ou plus récent
12.13.8. Migrer de la version 0.2.0 ou plus ancien vers 0.6.0

12.1. Zend_Controller - Démarrage rapide

12.1.1. Introduction

Zend_Controller est le coeur du système MVC de Zend Framework. MVC équivaut à Modèle-Vue-Contrôleuret est un motif de conception ("design pattern") visant à séparer la logique d'application de la logique d'affichage. Zend_Controller_Front implémente un modèle de contrôleur frontal ("Front Controller"), dans lequel toutes les demandes sont arrêtées par le contrôleur frontal et distribuées vers différents contrôleurs d'action ("Action Controller") basés sur l'URL demandé.

Le système Zend_Controller a été construit dans un souci d'extensibilité, soit par sous-classement des classes existantes, en écrivant les nouvelles classes qui implémentent les diverses interfaces et les classes abstraites qui forment la base de la famille de contrôleur des classes, soit par écriture de plugins ou d'aides d'action afin d'utiliser ou d'augmenter les fonctionnalités du système.

12.1.2. Démarrage rapide

Si vous avez besoin d'informations plus détaillées, lisez les sections suivantes. Si vous voulez juste démarrer rapidement, lisez ce qui suit.

12.1.2.1. Créer votre disposition de système de fichiers

La première étape est de créer votre disposition de système de fichiers. La disposition typique est la suivante :


application/
    controllers/
        IndexController.php
    models/
    views/
        scripts/
            index/
                index.phtml
        helpers/
        filters/
html/
    .htaccess
    index.php

12.1.2.2. Régler votre document root

Dans votre serveur Web, faîtes pointer votre "document root" vers le dossier html du système de fichiers ci-dessus.

12.1.2.3. Créer vos règles de réécriture

Éditez le fichier html/.htaccess afin de lire ceci :


RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]
[Note] Connaître mod_rewrite

Les règles de réécriture ci-dessus autorisent l'accès à tous fichiers sous la racine de votre hôte virtuel. Si vous avez des fichiers que vous ne souhaitez pas exposer, vous pouvez souhaiter restreindre ces règles. Allez sur le site d'Apache pour en apprendre davantage concernant mod_rewrite.

Si vous avez IIS 7.0, utilisez ceci pour votre configuration de réécriture :


<?xml version="1.0" encoding="UTF-8"?>
<configuration>
     <system.webServer>
         <rewrite>
             <rules>
                 <rule name="Imported Rule 1" stopProcessing="true">
                     <match url="^.*$" />
                     <conditions logicalGrouping="MatchAny">
                         <add input="{REQUEST_FILENAME}"
                             matchType="IsFile" pattern=""
                             ignoreCase="false" />
                         <add input="{REQUEST_FILENAME}"
                             matchType="IsDirectory"
                             pattern="" ignoreCase="false" />
                     </conditions>
                     <action type="None" />
                 </rule>
                 <rule name="Imported Rule 2" stopProcessing="true">
                     <match url="^.*$" />
                     <action type="Rewrite" url="index.php" />
                 </rule>
             </rules>
         </rewrite>
     </system.webServer>
</configuration>

Les règles ci-dessus vont redirigées toute requête vers des ressources existantes (liens symboliques, fichiers non vides, ou répertoires non-vides), tout autre requête sera renvoyée vers le contrôleur frontal.

[Note] Note

Les règles de réécriture ci-dessus sont pour Apache ; pour des exemples de règles de réécriture pour d'autres serveurs Web, reportez-vous à la documentation du routeur.

12.1.2.4. Créer votre fichier d'amorçage (bootstrap)

Le fichier d'amorçage est la page vers laquelle toutes les demandes sont dirigées -- html/index.php dans ce cas-ci. Ouvrez html/index.php dans l'éditeur de votre choix et ajouter ce qui suit :


Zend_Controller_Front::run('/chemin/vers/application/controllers');

Ceci va instancier et distribuer le contrôleur frontal, qui conduira les demandes vers les contrôleurs d'action.

12.1.2.5. Créer votre contrôleur d'action par défaut

Avant de discuter des contrôleurs d'action, vous devez d'abord comprendre comment les requêtes sont dirigées dans Zend Framework. Par défaut, le premier segment d'un chemin d'URL correspond à un contrôleur, et le second à une action. Par exemple, l'URL est http://framework.zend.com/roadmap/components, le chemin est /roadmap/components, qui correspondra au contrôleur roadmap et à l'action components. Si aucune action n'est fournie, l'action index est présumé, et si aucun contrôleur n'est fourni, le contrôleur index est présumé (suivant la convention Apache qui fait correspondre un DirectoryIndex automatiquement).

Le distributeur du Zend_Controller prend alors la valeur du contrôleur et le fait correspondre à une classe. Par défaut, il s'agit du nom du contrôleur suivi du mot Controller. Ainsi, dans notre exemple ci-dessus, le contrôleur roadmap correspond à la classe RoadmapController.

De la même manière, la valeur de l'action correspond à une méthode de la classe contrôleur. Par défaut, la valeur est écrit en minuscule, et le mot Action est ajouté. Ainsi, dans notre exemple ci-dessus, l'action components devient componentsAction, et la méthode finale appelée est RoadmapController::componentsAction().

Créons maintenant un contrôleur d'action par défaut et une méthode d'action. Comme noté auparavant, le contrôleur et l'action par défaut sont tous les deux nommées index. Ouvrez le fichier application/controllers/IndexController.php, et entrez ce qui suit :


/** Zend_Controller_Action */

class IndexController extends Zend_Controller_Action
{
    public function indexAction()
    {
        $this->render();
    }
}

Par défaut, l'aide d'action ViewRendererest activé. Ceci signifie qu'en définissant simplement une méthode d'action et un script de vue correspondant, vous obtiendrez automatiquement le rendu du contenu. Par défaut, Zend_View est utilisé en tant que couche Vue dans le MVC. Le ViewRenderer utilise le nom du contrôleur (par exemple, index) et le nom de l'action courante (par exemple, index) pour déterminer le modèle à afficher. Par défaut, le fichier modèle se termine par l'extension .phtml, cela signifie que dans l'exemple ci-dessus, le modèle index/index.phtml sera rendu. De plus, le ViewRenderer suppose automatiquement que le dossier views situé au même niveau que le dossier des contrôleurs est le dossier de base des vues, et que les scripts de vues sont dans le sous-dossier views/scripts/. Ainsi le modèle rendu sera trouvé dans application/views/scripts/index/index.phtml.

12.1.2.6. Créer votre script de vue

Comme mentionné dans la section précédente, les scripts de vue sont dans application/views/scripts/ ; le script de vue pour le contrôleur et l'action par défaut est donc application/views/scripts/index/index.phtml. Créer ce fichier, et saisissez ce HTML :


<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>My first Zend Framework App</title>
</head>
<body>
    <h1>Hello, World!</h1>
</body>
</html>

12.1.2.7. Créer votre contrôleur d'erreur

Par défaut, le plugin de gestion des erreursest enregistré. Ce plugin nécessite qu'un contrôleur existe pour gérer les erreurs. Par défaut, il s'agit d'un ErrorController dans le module par défaut avec une méthode errorAction :


/** Zend_Controller_Action */

class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
    }
}

En considérant l'architecture des dossiers vu ci-dessus, le fichier sera dans application/controllers/ErrorController.php. Vous devez aussi créer une script de vue dans application/views/scripts/error/error.phtml ; exemple de contenu possible :


<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>Erreur</title>
</head>
<body>
    <h1>Erreur apparue</h1>
    <p>Une erreur est apparue ; veuillez rééssayer plus tard.</p>
</body>
</html>

12.1.2.8. Voir le site !

Avec votre premier contrôleur et votre première vue, vous pouvez maintenant démarrer votre navigateur et aller sur votre site. En supposant que exemple.fr est votre domaine, chacun des URLs suivants vous dirigera vers la page que nous avons tout juste créée :

  • http://exemple.fr/

  • http://exemple.fr/index

  • http://exemple.fr/index/index

Vous êtes maintenant prêt à créer de nouveaux contrôleurs et de nouvelles méthodes d'action. Félicitations !


Search the Manual

Translation Status Reports

View the current status report of Zend Framework manual translations.