Utilisation de base des Placeholders

Zend Framework définit une aide de vue générique placeholder() que vous pouvez utiliser pour créer vos placeholders ("conteneurs") personnalisés. Il propose aussi une variété de placeholders pour des fonctionnalités très demandées comme préciser un DocType, le titre d'une page, etc.

Tous les placeholders agissent de la même manière. Ce sont des conteneurs, et donc vous pouvez les manipuler comme des collections. Vous pouvez ainsi :

  • Ajouter (append) ou préfixer(prepend) des entités dans la collection.

  • Remplacer (replace) toute la collection avec une seule valeur.

  • Spécifier une chaîne utilisée pour préfixer le contenu de la collection lors de son rendu.

  • Spécifier une chaîne utilisée pour ajouter le contenu de la collection lors de son rendu.

  • Spécifier une chaîne utilisée pour séparer du contenu de la collection lors de son rendu.

  • Capturer du contenu dans la collection.

  • Rendre le contenu agrégé.

Typiquement, vous appelerez cette aide de vue sans argument, ce qui retournera le conteneur sur lequel opérer. Après vous afficherez (echo) ce contenu ou appelerez une méthode dessus pour le remplir ou le configurer. Si le conteneur est vide, son rendu sera une simple chaîne vide, sinon, le contenu sera aggrégé en fonction des règles que vous avez fixées.

Par exemple, créons une barre de menu qui contient des "blocs" de contenu. Supposons que la structure de chaque bloc ressemble à ceci :

  1. <div class="sidebar">
  2.     <div class="block">
  3.         <p>
  4.             Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
  5.             consectetur aliquet odio ac consectetur. Nulla quis eleifend
  6.             tortor. Pellentesque varius, odio quis bibendum consequat, diam
  7.             lectus porttitor quam, et aliquet mauris orci eu augue.
  8.         </p>
  9.     </div>
  10.     <div class="block">
  11.         <ul>
  12.             <li><a href="/some/target">Link</a></li>
  13.             <li><a href="/some/target">Link</a></li>
  14.         </ul>
  15.     </div>
  16. </div>

Le contenu variera en fonction du contrôleur et de l'action, mais la structure est identique, elle. Configurons en premier lieu la barre de menu dans une méthode du bootstrap :

  1. class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  2. {
  3.     // ...
  4.  
  5.     protected function _initSidebar()
  6.     {
  7.         $this->bootstrap('View');
  8.         $view = $this->getResource('View');
  9.  
  10.         $view->placeholder('sidebar')
  11.              // "prefix" -> contenu à afficher une fois avant les données
  12.              // dans la collection
  13.              ->setPrefix("<div class=\"sidebar\">\n    <div class=\"block\">\n")
  14.              // "separator" -> contenu à afficher entre chaque entité de
  15.              // la collection
  16.              ->setSeparator("</div>\n    <div class=\"block\">\n")
  17.              // "postfix" -> contenu à afficher une fois après les données
  18.              // dans la collection
  19.              ->setPostfix("</div>\n</div>");
  20.     }
  21.  
  22.     // ...
  23. }

Le code ci-dessus définit un placeholder, "sidebar", qui n'a pas d'entité. Ce code configure la structure de base du placeholder, selon nos désirs.

Maintenant supposons que pour toutes les actions du contrôleur "user" nous voulons un bloc en haut qui contienne des informations. Nous pouvons faire cela de deux manières : (a) nous pourrions ajouter le contenu au placeholder directement dans la méthode preDispatch() du contrôleur, ou (b) nous pourrions rendre un script de vue depuis la méthode preDispatch(). Nous utiliserons le cas (b), car il propose une séparation propre des logiques en laissant la vue classique contenir ses données utiles.

Nous appelerons le script de vue "user/_sidebar.phtml", et nous le remplirons comme ceci :

  1. <?php $this->placeholder('sidebar')->captureStart() ?>
  2. <h4>User Administration</h4>
  3. <ul>
  4.     <li><a href="<?php $this->url(array('action' => 'list')) ?>">
  5.         List</a></li>
  6.     <li><a href="<?php $this->url(array('action' => 'create')) ?>">
  7.         Create</a></a></li>
  8. </ul>
  9. <?php $this->placeholder('sidebar')->captureEnd() ?>

L'exemple ci-dessus utilise les possibilités de capture dynamique de contenu des placeholders. Par défaut, le contenu est ajouté à la suite ce qui permet d'en agréger. Cet exemple utilise des aides de vues et du contenu HTML statique pour générer un menu qui est capturé et ajouté au placeholder.

Pour utiliser le script de vue, nous écrirons ceci dans la méthode preDispatch() :

  1. class UserController extends Zend_Controller_Action
  2. {
  3.     // ...
  4.  
  5.     public function preDispatch()
  6.     {
  7.         // ...
  8.  
  9.         $this->view->render('user/_sidebar.phtml');
  10.  
  11.         // ...
  12.     }
  13.  
  14.     // ...
  15. }

Notez que nous ne capturons pas le rendu, il n'y a pas besoin car le contenu complet de ce script de vue est déja capturé dans un placeholder.

Maintenant imaginons que l'action "view" dans ce même contrôleur ait besoin de présenter des informations. Dans "user/view.phtml" il pourrait y avoir ceci :

  1. $this->placeholder('sidebar')
  2.      ->append('<p>User: ' . $this->escape($this->username)'</p>');

Cet exemple utilise la méthode append() et lui passe du contenu à agréger.

Enfin, modifions le script de layout pour rendre le placeholder :

  1. <html>
  2. <head>
  3.     <title>My Site</title>
  4. </head>
  5. <body>
  6.     <div class="content">
  7.         <?php echo $this->layout()->content ?>
  8.     </div>
  9.     <?php echo $this->placeholder('sidebar') ?>
  10. </body>
  11. </html>

Pour les contrôleurs et les actions que ne remplissent pas le placeholder "sidebar", aucun contenu ne sera rendu ; cependant afficher le placeholder rendra le contenu "fixe" suivant les règles définies dans le bootstrap ainsi que le contenu agrégé dans l'application. Dans le cas de l'action "/user/view", en supposant que le nom de l'utilisateur est "matthew", nous pouvons récupérer le contenu de la barre de menu comme ceci (formaté pour la lisibilité de l'exemple) :

  1. <div class="sidebar">
  2.     <div class="block">
  3.         <h4>User Administration</h4>
  4.         <ul>
  5.             <li><a href="/user/list">List</a></li>
  6.             <li><a href="/user/create">Create</a></a></li>
  7.         </ul>
  8.     </div>
  9.     <div class="block">
  10.         <p>User: matthew</p>
  11.     </div>
  12. </div>

Les possibilités sont immenses en ce qui concerne les placeholders et les layouts, essayez les et lisez les sections relatives du manuel pour plus d'informations.

blog comments powered by Disqus