Atelier Zend Framework: Utiliser Zend Paginator Dans Un Environnement MVC Simple

Atelier Zend Framework : Utiliser Zend Paginator dans un environnement MVC simple
par Julien Pauli (Tutoriels, article et confrences PHP et developpement web) (Blog)
Date de publication : 03/12/2008 Dernire mise jour :
Beaucoup de questions se posent sur Zend_Paginator, avec parfois des problmes. Pourtant ce composant, apparu dans ZendFramework 1.6, est trs simple prendre en main, condition toujours de savoir comment il fonctionne en interne. Un composant principal, qui pilote un adaptateur bas sur un pattern Itrateur, rien de plus, rien de moins. Nous allons tenter de dcortiquer tout cela ensemble.
Atelier Zend Framework : Utiliser Zend Paginator dans un environnement MVC simple par Julien Pauli (Tutoriels, article et confrences PHP et developpement web) (Blog)
I - Prsentation du composant Zend_Paginator......................................................................................................... 3 II - Mise en place de l'architecture d'exemple.............................................................................................................5 II-A - Base de donnes..........................................................................................................................................5 II-B - Modle MVC................................................................................................................................................. 6 III - Utiliser le paginateur............................................................................................................................................. 8 III-A - Pagination de la liste des membres............................................................................................................ 8 III-B - Afficher la barre de pagination.................................................................................................................... 9 IV - Amliorer.............................................................................................................................................................10 IV-A - Des URLs plus propres............................................................................................................................. 10 IV-B - Gestion des contextes XML et JSON....................................................................................................... 10 V - Autres utilisations du paginateur......................................................................................................................... 12 VI - Conclusions.........................................................................................................................................................13
-2Copyright 2008 - Julien Pauli. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de dommages et intrts.
http://julien-pauli.developpez.com/tutoriels/zend-framework/atelier/paginator/
I - Prsentation du composant Zend_Paginator

Zend_Paginator est un composant apparu en version 1.6 de Zend Framework. Son nom est explicite, je ne vais pas faire un dessin, encore que si, allez :
Diagramme de classes simplifi de Zend_Paginator Voila, a va mieux dja pour la comprhension. Ce diagramme de classes est simplifi, il ne prsente pas toutes les mthodes, ni les attributs de classe. Zend_Paginator est la classe principale qui va piloter la pagination d'un objet adaptateur. Zend_Paginator ne fonctionne donc pas sans adaptateur, il y a agrgation comme on peut le noter. Une mthode factory() sert simplifier la cration d'un paginateur avec directement le bon adaptateur dedans, en sachant qu'il existe dj ce jour 5 adaptateurs dans la distribution de Zend Framework. Vous pouvez crer vos propres adaptateurs, condition qu'ils implmentent Zend_Paginator_Adapter_Interface, et vous pouvez les charger dans Zend_Paginator grce sa dpendance envers Zend_Loader_PluginLoader (classe permettant de charger des composants utilisateurs de manire simple et pratique). Les adaptateurs ont tous un nom trs explicite. Je rappelle que pour Iterator, il prend en paramtre une classe implmentant l'interface PHP Iterator. Null lui, sert charger dans le paginateur rien... Le but est d'avoir une instance de Zend_Paginator mais sans donnes piloter (je rappelle qu'on ne peut crer une instance de Zend_Paginator sans adaptateur). Il n'y a ensuite plus rien faire au sujet de l'adaptateur, tout va se passer sur l'instance de Zend_Paginator. Zend_Paginator va alors avoir les rles suivants :
1 2 3
Crer une fentre de visibilit paramtrable sur les donnes de l'adaptateur Proposer une faade de pilotage des donnes, via itration entre autres Donner le moyen d'afficher, via une vue Zend_View, le contrle de la pagination
II - Mise en place de l'architecture d'exemple

Nous allons mettre en place un petit exemple concret en utilisant le modle MVC de Zend Framework, bas sur le composant Zend_Controller. Rien de bien complexe, le but est de se pencher sur Zend_Paginator en affichant une liste de membres, depuis une table d'une base de donnes. Accessoirement, nous verrons en dernire partie d'autres listes. A ce titre, voici un dtail de l'architecture : 1 2 MembresController va contenir une mthode liste qui renverra une liste pagine des membres en base IndexController servira pour deux exemples annexes du paginateur, n'ayant rien voir avec les membres
architecture du projet Paginateur
II-A - Base de donnes

Notre base de donnes est des plus simples, nous n'allons mme pas la dtailler. Nous supposerons une table "membres", avec une seule colonne "nom". En revanche, nous allons utiliser quelques artefacts de Zend Framework pour nous simplifier la vie. Voici dj la configuration de la base de donnes, sous forme de fichier .ini grable par Zend_Config.
main.ini
cache.lifetime = 3600 db.adapter = pdo_mysql db.params.host = localhost db.params.password = anaska db.params.username = julien db.params.dbname = mle
Nous vous supposons l'aise avec le paquet Zend_Db, et ses sous paquets comme Zend_Db_Table ou Zend_Db_Select, mme si nous tcherons de rester trs simples.
II-B - Modle MVC

Concernant le modle MVC, nous allons dtailler les fichiers un un, l encore le but est de ne pas faire dans le superflu pour ne pas compliquer la comprhension. Nous rajouterons cependant quelques fonctionnalits annexes, comme par exemple une route personnalise permettant de bnficer d'URL plus sympas. L'architecture MVC prsente ici est trs classique. index.php ne fait qu'inclure bootstrap.php, dont voici le dtail : bootstrap.php
<?php require_once 'Zend/Loader.php'; Zend_Loader::registerAutoload(); $appPath = dirname(__FILE__); $rootPath = dirname($appPath); set_include_path(get_include_path() . PATH_SEPARATOR . $appPath . '/default/models/' . PATH_SEPARATOR ); // --------------------- CONFIG ----------------------------------$config = new Zend_Config_Ini($appPath .'/default/config/main.ini'); // ------------------------ CACHE ---------------------------------$backOptions = array(); $frontOptions = array('lifetime' => $config->cache->lifetime, 'automatic_serialization'=>true); $cache = Zend_Cache::factory('Core', 'APC', $frontOptions, $backOptions); // ----------------------- DB --------------------------------------try { $db = Zend_Db::factory($config->db); $db->getConnection(); Zend_Db_Table_Abstract::setDefaultAdapter($db); Zend_Db_Table_Abstract::setDefaultMetadataCache($cache); } catch (Zend_Exception $e) { exit($e); } // ------------------------------ PAGINATOR -------------------------Zend_View_Helper_PaginationControl::setDefaultViewPartial('pagination.phtml'); // ------------------------- MVC ------------------------------------$vr = Zend_Controller_Action_HelperBroker::getStaticHelper('ViewRenderer'); $vr->setViewScriptPathSpec(":controller-:action.:suffix"); $frontController = Zend_Controller_Front::getInstance(); $frontController->setControllerDirectory($appPath . '/default/controllers/'); $frontController->throwExceptions(true); $frontController->dispatch();
Les sections logiques sont spares par des lignes de commentaires pour plus de visibilit. Idem pour la gestion des erreurs : nous demandons explicitement une connexion la base ( $db->getConnection() ), et si problme, on fait un vulgaire exit() PHP. Concernant la partie Zend_Db, que du "classique" nous prenons soin par contre d'insrer une instance de Zend_Cache_Core afin de mettre en cache les mtadonnes issues de la base de donnes. Ceci pour des raisons de performance videntes, mme si ici ce genre de problmatique est loin de nous concerner. Vient ensuite la section MVC. Rien de particulier, si ce n'est que l'on change la manire dont les vues sont appeles avec une inflection 'controller-action.suffix' au lieu de 'controller/action.suffix' par dfaut. Question de convenance... Aussi, nous instruisons le contrleur frontal de renvoyer les exceptions qu'il rencontre. Il n'y a donc pas de contrleur ddi la gestion d'erreurs.
III - Utiliser le paginateur

La paginateur n'est pas difficile d'utilisation. Il utilise obligatoirement un adaptateur (nous allons voir cela), et il peut en option utiliser une aide de vue (Zend_View_Helper_PaginationControl). Cette aide est trs pratique pour piloter de manire simple le paginateur depuis une vue. Aussi, cette aide va permettre de grer la barre de navigation qui affichera les pages restantes, prcdentes, suivantes. Cette barre est totalement isole du reste de la vue, et est reprsente par un fichier, ici pagination.phtml, aussi appel "partial" ou vue partielle. Ce fichier est pris relativement au scriptPath de la vue, soit dans notre cas default/ view/scripts/ La mthode setDefaultViewPartial() de l'aide de vue Zend_View_Helper_PaginationControl, va permettre de spcifier quelle sera la vue partielle utilise dans toutes les vues, pour la navigation. Autrement, il faudra le prciser chaque fois que l'on fait un rendu, ce qui est un peu pnible.
III-A - Pagination de la liste des membres

Voyons ds lors quoi ressemble notre MembresController : MembresController
<?php class MembresController extends Zend_Controller_Action { public function listeAction() { $TMembres = new TMembres(); $select = $TMembres->select(); $page = Zend_Paginator::factory($select); $page->setPageRange(2); $page->setCurrentPageNumber($this->_getParam('page', 1)); $page->setItemCountPerPage($this->_getParam('par', 1)); $this->view->listeMembres = $page; } }
Notre classe TMembres est une Zend_Db_Table trs classique, mise en include_path, nous pouvons donc l'appeler directement, nous ne dtaillerons pas son code ici. Nous crons ensuite une instance de Zend_Paginator, grce sa fabrique factory(). Celle-ci va automatiquement reconnaitre l'objet Zend_Db_Table_Select, et agir en consquence, c'est dire crer un objet Zend_Paginator encapsulant un objet Zend_Paginator_Adapter_DbTableSelect Ds lors, Zend_Paginator va piloter l'objet select sous-jacent, et nous, nous allons piloter le paginateur. Il n'y a rien faire sur l'objet select : pas besoin de chercher des rsultats, ou quoi que ce soit d'autre, au lieu de cela, il faut dire au paginateur quelles donnes il va devoir chercher. La mthode setCurrentPageNumber() dfinit la page en cours dans la fentre de pagination des donnes. La mthode setItemCountPerPage() renseigne sur le nombre de rsultats par page A partir de l, Zend_Paginator va piloter l'objet adaptateur pour lui faire chercher la bonne fentre de donnes, il n'y a plus rien faire (d'obligatoire). Eventuellement, nous dcidons de changer l'amplitude des pages que l'aide partielle de vue nous prsentera. Au lieu de montrer 10 numros de pages par dfaut, nous choisissons grce setPageRange() de n'en afficher que 2. Enfin, nous passons directement l'instance du paginateur ($page ici) la vue, et c'est fini pour la partie contrleur. Passons la vue : l'affichage des donnes membres-liste.phtml
<ul> <?php foreach ($this->listeMembres as $membre) { echo "<li>$membre->nom</li>"; } ?> </ul> -8Copyright 2008 - Julien Pauli. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de dommages et intrts.
membres-liste.phtml
<?php echo $this->listeMembres;
La vue va se servir de l'instance Zend_Paginator passe (listeMembres) et va itrer dessus. Zend_Paginator implmentant l'interface IteratorAggregate, il va en fait proxier les appels de l'itrateur sur l'objet adaptateur sousjacent. Un simple foreach fait donc l'affaire ! Et dans notre cas, nous rcuprons des objets Zend_Db_Table_Row, en ralit la boucle foreach a travers l'itrateur des Zend_Db_Table_Rowset aussi (la magie des itrateurs de PHP5 est toujours impressionnante) La ligne echo $this->listeMembres; demande d'afficher l'instance Zend_Paginator. Celle-ci possde une mthode __toString(), et elle va chercher la vue partielle que nous lui avions dfinie (setDefaultViewPartial()) afin d'afficher la barre de pagination. A quoi ressemble-t-elle ? C'est ce que nous allons voir.
III-B - Afficher la barre de pagination

pagination.phtml
<?php if ($this->pageCount): ?> <div id="paginationControl">  <?php if (isset($this->previous)): ?> <a href="<?php echo $this->url(array('page' => $this->previous)); ?>">< <?php echo "prcdent"; ? ></a> | <?php else: ?> <span class="disabled">< <?php echo "prcdent"; ?></span> | <?php endif; ?>  <?php foreach ($this->pagesInRange as $page): ?> <?php if ($page != $this->current): ?> <a href="<?php echo $this->url(array('page' => $page)); ?>"><?php echo $page; ?></a> | <?php else: ?> <span class="current"><?php echo $page; ?></span> | <?php endif; ?> <?php endforeach; ?>  <?php if (isset($this->next)): ?> <a href="<?php echo $this->url(array('page' => $this->next)); ?>"><?php echo "suivant" ?> ></a> <?php else: ?> <span class="disabled"><?php echo "suivant" ?> ></span> <?php endif; ?> </div> <?php endif; ?>
En fait, on ne s'est pas embts puisque le code ci-dessus est issu de la documentation officielle, tel quel (short_open_tags PHP purs). Toutes les donnes $this-> sont mises disposition par Zend_Paginator, la documentation officielle les dtaille toutes.
Pagination au format HTML
IV - Amliorer IV-A - Des URLs plus propres

Actuellement pour interroger nos pages, nous sommes obligs d'utiliser le routeur par dfaut. Nous avons donc des URLs comme http://somehost/paginateur/membres/liste/page/2/par/4 pour afficher la page 2 de la liste des membres raison de 4 rsultats par page. C'est pas trs joli, nous allons monter rapidement une URL plus sympathique : rajout bootstrap.php
<?php $configRoute = new Zend_Config_Ini($appPath .'/default/config/routes.ini'); $frontController->getRouter()->addConfig($configRoute);
routes.ini
listemembre.type listemembre.route listemembre.reverse listemembre.defaults.controller listemembre.defaults.action listemembre.defaults.page listemembre.defaults.par listemembre.map.1 listemembre.map.2 = = = = = = = = = "Zend_Controller_Router_Route_Regex" "liste-des-membres(?:-page-(\d+))?(?:-par-(\d+))?\.html" "liste-des-membres-page-%d-par-%d.html" membres liste 1 2 page par
Voila, nous pouvons ds lors interroger nos pages avec http://somehost/paginateur/liste-des-membres-page-2par-4.html , plus cool non? Et les paramtres sont facultatifs, donc ceci fonctionne : http://somehost/paginateur/liste-des-membres-page-2.html, ou encore http://somehost/paginateur/liste-des-membres-par-4.html Des problmes restent prvoir sur les URLs inverses, car l'inverseur va crer des liens dans lesquels ces paramtres l apparaitront obligatoirement. Pour viter cela, il faut driver les classes de routage, si vous vous sentez, c'est votre exercice ;-)
IV-B - Gestion des contextes XML et JSON

La commutation de contextes est un sujet part entire, nous allons juste en toucher 2 mots trs rapides. Il est tellement simple, partant de notre belle liste HTML, d'en faire des listes XML et JSON, que nous n'allons pas nous en priver. Pour faire ragir les contextes, par dfaut, il faut passer un paramtre GET appel 'format', et lui donner les valeurs 'xml' ou 'json'. rajouts MembresController
<?php class MembresController extends Zend_Controller_Action { public function init() { $this->_helper->contextSwitch->addActionContext('liste', array('json','xml')) ->initContext(); } public function postDispatch() { if ($this->_helper->contextSwitch->getCurrentContext() == 'json') { $this->_helper->json->sendJson($this->view->listeMembres->getCurrentItems()->toArray()); } }
init() initialise la commutation de contexte.

- 10 Copyright 2008 - Julien Pauli. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de dommages et intrts.
postDispatch() permet de court-circuiter les actions par dfaut du commutateur, car notre objet Zend_Paginator ne peut tre encod en JSON de manire directe. Il faut donc dtecter le contexte JSON, et demander le rendu JSON des entits actuellement dans le paginateur (getCurrentItems()), sous forme de tableau (c'est un Zend_Db_Table_Rowset sinon) On obtient donc quelque chose comme ceci : liste au format json
[{"nom":"Julien"},{"nom":"estelle"}]
Pour le XML, il suffit de crer une vue avec l'extension xml.phtml, et de crer le XML que l'on souhaite dedans. Par exemple comme cela : membres-liste.xml.phtml
<?php $xml = new XMLWriter(); $xml->openMemory(); $xml->startDocument(); $xml->startElement('membres'); foreach ($this->listeMembres as $membre) { $xml->writeElement('membre', $membre->nom); } $xml->endElement(); $xml->endDocument(); echo $xml->flush(); ?>
Liste au format XML
V - Autres utilisations du paginateur

Sortons de la liste des membres, pour montrer d'autres utilisations du paginateur. Par exemple avec l'adaptateur array, ou iterator, voyez plutt cet IndexController qui dmontre ceci : indexController
<?php class IndexController extends Zend_Controller_Action { public function xmlAction() { $xml = "<data><nom>julien</nom><nom>estelle</nom></data>"; $page = Zend_Paginator::factory(new SimpleXMLIterator($xml)); $page->setCurrentPageNumber($this->_getParam('page')); $page->setItemCountPerPage(2); $this->view->items = $page; } public function arrayAction() { $phpFunctions = get_defined_functions(); $page = Zend_Paginator::factory(array_shift($phpFunctions)); $page->setCurrentPageNumber($this->_getParam('page')); $page->setItemCountPerPage(50); $this->view->items = $page; }
Nous ne montrons pas les vues, qui coulent de source. xmlAction() utilise un SimpleXMLIterator pour itrer sur tous les noeuds d'un code XML. arrayAction() nous montre une liste pagine de toutes les fonctions internes PHP. On aurait pu tout aussi bien choisir un Zend_Feed::factory('une-url') qui retourne un objet implmentant Iterator, par exemple.
VI - Conclusions
Oui Zend_Paginator possde encore tout un tas de mthodes que nous n'avons pas vues. Elles restent simples maitriser tant qu'on a compris le principe d'agrgation et de pilotage de Zend_Paginator sur le Zend_Paginator_Adapter_* qu'il contient. Aussi, on aurait pu utiliser un objet Zend_Config avec le paginateur, on aurait pu changer le style de la barre de navigation travers les pages. Le composant est (comme d'habitude avec Zend Framework) trs souple : l'tendre pour le personnaliser n'est pas compliqu, j'ai d'ailleurs quelques ides proposer prochainement, comme le fait de pouvoir mettre en cache permanent les donnes sur lesquelles le paginateur est dj pass (la proposition est lance sur le tracker de ZF). La SPL et les itrateurs Zend_Db expliqu en dtail Les expressions rgulires en PHP Dbuter avec le modle MVC de ZendFramework

Atelier Zend Framework: Utiliser Zend Paginator Dans Un Environnement MVC Simple

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Atelier Zend Framework: Utiliser Zend Paginator Dans Un Environnement MVC Simple

Transféré par

Droits d'auteur :

Formats disponibles

Atelier Zend Framework : Utiliser Zend Paginator dans un environnement MVC simple

I - Prsentation du composant Zend_Paginator

II - Mise en place de l'architecture d'exemple

architecture du projet Paginateur

II-A - Base de donnes

II-B - Modle MVC

III - Utiliser le paginateur

III-A - Pagination de la liste des membres

<?php echo $this->listeMembres;

III-B - Afficher la barre de pagination

Pagination au format HTML

IV - Amliorer IV-A - Des URLs plus propres

<?php $configRoute = new Zend_Config_Ini($appPath .'/default/config/routes.ini'); $frontController->getRouter()->addConfig($configRoute);

IV-B - Gestion des contextes XML et JSON

init() initialise la commutation de contexte.

Liste au format XML

V - Autres utilisations du paginateur

Vous aimerez peut-être aussi