9.3 Le MVC du Zend Framework 373 9.3 LE MVC DU ZEND FRAMEWORK Nous avons déjà vu l’essentiel de l’organisation du Zend Framework pour les contrô- leurs et les actions 2 . Voici quelques compléments d’utilisation courante. Le code décrit dans cette section appartient au contrôleur MvcController.php. 9.3.1 L’objet request Les paramètres reçus par une action sont placés dans un objet request que l’on obtient avec la méthode getRequest() d’un contrôleur. De nombreuses méthodes applicables à cet objet servent à récupérer les informations relatives à la requête HTTP qui a déclenché l’action. En voici une liste non exhaustive. 1. getControllerName() 2. getActionName() 3. getMethod() 4. getQuery($key=null, $defaut=null) 5. getPost($key=null, $defaut=null) 6. getCookie($key=null, $defaut=null) 7. getParam($key=null, $defaut=null) À chaque fois si $key est null, on obtient un tableau donnant toutes les informations disponibles (par exemples, tous les cookies). L’exemple qui suit montre comment récupérer tous les paramètres passés à une action. Notez également que request sert à obtenir le nom du contrôleur et de l’action courante. function requestAction() { // Récupérons la requête $request = $this−>getRequest() ; // On obtient le nom du contrôleur et de l ’action $this−>view−>nom_controleur = $request−>getControllerName() ; $this−>view−>nom_action = $request−>getActionName() ; // Prenons les paramètres HTTP $params = $request−>getParams() ; $this−>view−>liste_params = ""; foreach ($params as $nom => $valeur) $this−>view−>liste_params .= " ($nom = $valeur) "; } Au lieu de parler de paramètres HTTP, il serait plus judicieux de parler de paramètres en général, transmis à une méthode dans une classe orienté-objet. Il est possible en effet, avec le Zend Framework, de déclencher une action à partir 2. Un troisième niveau dans la hiérarchie, les modules, est possible. 374 Chapitre 9. Introduction au Zend Framework d’une autre action (avec un forward()) en lui passant un objet request créé de toutes pièces sans passer par HTTP. Le mécanisme d’encapsulation obtenu par la programmation objet a pour effet de fournir des applications et des composants qui ne sont plus liés à un environnement d’exécution particulier. 9.3.2 L’objet response Le complément de l’objet request est l’objet response qui encapsule les méthodes gérant la production du résultat (ceux qui ont déjà programmé en Java/Servet/JSP ne seront pas dépaysés). L’objet response est utile par exemple quand on produit un résultat non HTML, auquel cas il faut modifier les entêtes de la réponse HTTP, sans recourir au composant Vue. L’exemple suivant montre comment renvoyer un document en texte brut. function responseAction() { // Ne pas utiliser la vue $this−>getHelper( ’ViewRenderer ’ )−>setNoRender() ; // Modifier l ’en−tête HTTP donnant le type du document // renvoyé $this−>getResponse()−>setHeader( ’Content−type ’ , ’text /plain ’) ; $reponse = "Je suis une réponse en texte pur"; $this−>getResponse()−>setBody($reponse) ; } 9.3.3 Gérer les exceptions Pour conclure cet aperçu des techiques de programmation MVC avec le Zend Fra- mework, revenons sur la gestion des exceptions. Pour l’instant, nous avons demandé au contrôleur frontal de lever des exceptions avec l’instruction suivante placée dans le fichier index.php. $front−>throwExceptions(true); Ce n’est pas vraiment une bonne méthode car une exception sera redirigée vers le bloc catch du fichier index.php qui va devoir tout gérer. La gestion par défaut des exceptions consiste à déclencher une action error d’un contrôleur ErrorController.php. Ce contrôleur existe dans ZS COPE. Commentez l’appel throwException() dans index.php, et déclenchez une exception pour voir ce qui se passe. Vous pouvez tout simplement déclencher l’action exception du contrôleur mvc, dont voici le code. function exceptionAction() { throw new Zend_Exception ("J ’envoie une exception ") ; } 9.3 Le MVC du Zend Framework 375 Cette action lève une exception, dirigée vers le contrôleur Error. La requête créée pour cette redirection contient un paramètre error_handler qui analyse l’exception levée. Cette dernière peut de deux types : 1. soit une erreur déclenchée par le Zend Framework lui-même, par exemple un contrôleur ou une action qui n’existe pas ; 2. soit une exception levée par l’application. Voici le code complet de l’action error du contrôleur Error pour l’application ZS COPE. On produit un message indiquant de manière complète l’endroit où l’ex- ception a été levée, ainsi que le message associé. function errorAction() { $this−>titre_page = "Une exception a été rencontrée" ; // On récupère le gestionnaire d’exception $eh = $this−>_getParam( ’error_handler ’); if ( is_object ($eh)) { $errmess = $script = $line = ""; $context = " Erreur" ; // Vérifions le type d’exception rencontrée switch ($eh−>type) { case Zend_Controller_Plugin_ErrorHandler :: EXCEPTION_NO_CONTROLLER : case Zend_Controller_Plugin_ErrorHandler :: EXCEPTION_NO_ACTION : $context = " Erreur Zend MVC " ; $errmess = "Contrôleur ou action inconnue"; break ; case Z e n d _ C o n t r o l l e r _ P l u g i n _ E r r o r H a n d l e r : : EXCEPTION_OTHER : default : $exception = $eh−>exception ; $script = $exception−>getFile(); $line = $exception−>getLine() ; $errmess = $exception−>getMessage () ; $context = get_class($exception); break ; } // On crée le message $this−>view−>message = "($context) Script $script ligne $line : $errmess" ; } else { $this−>view−>message = "Erreur interne"; } } 376 Chapitre 9. Introduction au Zend Framework Cette action devrait encore être améliorée pour tenir compte du contexte. Dans une application en production il faudrait afficher un message neutre sur l’indisponi- bilité de l’application, et envoyer un em-ail à l’administrateur du site avec le message précis de l’erreur rencontrée. 9.4 LA VUE DANS LE ZEND FRAMEWORK Cette section revient sur le système de vues proposé par le Zend Framework. 9.4.1 Les vues sont des scripts PHP Un script de vue a pour objectif de produire un document. La solution proposée par Zend pour gérer les vues dans l’architecture MVC a le mérite de la simplicité. Le langage de templates est PHP lui-même ; la seule particularité est que la vue dispose d’un ensemble de données à afficher qui lui ont été affectées par l’action associée. L’exemple suivant est la vue fetch.phtml associée à l’action fetch du contrôleur Bd, présenté un peu plus haut. Cette vue a reçu trois types de données : un tableau d’objets (des films), un objet (un film) et une chaîne de caractères (un titre). Exemple 9.6 zscope/application/views/scripts/bd/fetch.phtml : lavuedel’actionfetch Voici quelques exemples de méthodes <tt>fetch </tt> pour la requête "<i ><?php echo $this −>escape($this−>requete) ; ?></i>" . <h2>Méthode <tt>fetchAll </tt ></h2> <ol> <?php foreach ($this−>films as $film) { ?> <li ><?php echo $this−>escape($film−>titre) ; ?></li> <?php } ?> </ol > <h2>Méthode <tt >fetchRow </ tt ></h2> On ne trouve qu ’une ligne avec le film <i ><?php echo $this −>escape($this−>film−>titre) ."paruen" .$this−>film−>annee ; ?></i >. <h2>Méthode <tt >fetchOne </ tt ></h2> On ne prend que la première valeur de la première ligne . Ici le titre <i><?php echo $this−>escape($this−>titre );?></i >. La vue agit comme un script PHP, avec toute la puissance potentielle du langage. D’un côté, cela résout très simplement le problème des boucles ou des tests dans 9.4 La vue dans le Zend Framework 377 des templates, qui mène à des langages de templates parfois inutilement compliqués. D’un autre côté, on se retrouve avec des scripts qui ouvrent et ferment sans cesse les balises PHP, ce qui peut devenir lassant et donne un résultat moins facile à lire. Attention également à ne pas utiliser un script-vue pour faire de la programma- tion PHP. C’est possible avec cette approche, et il faut bien garder en tête que la vue ne doit implanter aucune intelligence, aucune logique. Elle doit juste produire un document. Zend permet le remplacement de son système de vues par un autre, basé par exemple sur des templates. Il faut implanter l’interface Zend_View_Interface.Un exemple est donné dans la documentation pour les templates Smarty. 9.4.2 Le layout Quand on développe un site, toutes les pages ont une présentation commune, désignée par le terme de layout. Si le système de vues Zend se limitait à un script pour chaque action, cela rendrait assez difficile, ou peu élégant, la gestion de ce layout commun. On pourrait produire des ent-êtes et des pieds de page, mais cette solution laborieuse rend plus difficile la conception du layout comme un document HTML homogène et bien formé. C’est ici qu’intervient l’instruction startMvc() placée dans index.php, que nous n’avions pas encore commentée. Le layout implante la charte graphique du site. C’est un document nommé layout.phtml, situé dans views/scripts, qui consiste essentiellement en un document HTML, avec quelques instructions comme celle-ci : <?php echo $this->escape($this->titre_page); ?> Tout se passe comme si le layout était un script PHP standard dans lequel on peut insérer des instructions echo. Les données disponibles pour l’affichage sont les propriétés d’un objet $this qui constitue le contexte du layout.Lelayout contient également une instruction assez spéciale. <?php echo $this->layout()->content; ?> De quoi s’agit-il ? Le système de vues proposé par défaut par le ZF fonctionne à deux niveaux. Quand une action s’exécute, le document résultat, obtenu par exécution du template associé à l’action, est placé dans une entité content. Cette entité peut alors, dans un second temps, être insérée à l’endroit approprié dans le layout qui constitue le second niveau. Pour prendre l’exemple de notre action index dans le contrôleur Index,le template index.phtml est tout d’abord exécuté, et donne pour résultat un fragment HTML. Ce fragment est affecté à l’entité content du layout.Lelayout lui-même est finalement affiché. REMARQUE – C’est l’instruction startMvc() placée dans le boostrap file qui établit cette réalisation à deux niveaux de la vue. On peut omettre cette instruction et se contenter d’un seulniveau(essayez ),maisildevientalorsassezdifficiled’organiseraveclogiquelesfichiers constituant la vue. . getControllerName() 2. getActionName() 3. getMethod() 4. getQuery($key=null, $defaut=null) 5. getPost($key=null, $defaut=null) 6. getCookie($key=null, $defaut=null) 7. getParam($key=null, $defaut=null) À. types de données : un tableau d’objets (des films), un objet (un film) et une chaîne de caractères (un titre). Exemple 9.6 zscope/application/views/scripts/bd/fetch.phtml : lavuedel’actionfetch Voici. passant un objet request créé de toutes pièces sans passer par HTTP. Le mécanisme d’encapsulation obtenu par la programmation objet a pour effet de fournir des applications et des composants