Programmer's Reference Guide

Introduction

Zend_Layout
Guide de référence du programmeur

Zend_Layout - Démarrage rapide

Il y a deux modes d'utilisation de Zend_Layout : avec Zend Framework MVC, et sans.

Scripts de layout

Dans tous les cas, un script de layout est nécessaire. Les scripts de layout utilisent simplement Zend_View (ou une implémentation particulière personnalisée). Les variables de layout sont enregistrées dans le placeholder Layout, et peuvent être accédées via l'aide de vue placeholder ou directement en tant que propriétés de l'objet layout.

Par exemple :

<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Mon Site</title>
</head>
<body>
<?php
    // récupère la clé "content" via l'aide de vue layout :
    echo $this->layout()->content;
 
    // récupère la clé "foo" via l'aide de vue placeholder :
    echo $this->placeholder('Zend_Layout')->foo;
 
    // récupère l'objet layout, et accède à diverses clés :
    $layout = $this->layout();
    echo $layout->bar;
    echo $layout->baz;
?>
</body>
</html>

Toutes les aides de vue enregistrées sont accessibles dans Zend_Layout car il utilise Zend_View pour son propre rendu. Vous pouvez aussi accéder aux variables de la vue. Les aides placeholder sont très pratiques pour l'accès aux éléments tels que <head>, les scripts, les méta, etc. :

<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <?php echo $this->headTitle() ?>
    <?php echo $this->headScript() ?>
    <?php echo $this->headStyle() ?>
</head>
<body>
    <?php echo $this->render('header.phtml') ?>
 
    <div id="nav"><?php echo $this->placeholder('nav') ?></div>
 
    <div id="content"><?php echo $this->layout()->content ?></div>
 
    <?php echo $this->render('footer.phtml') ?>
</body>
</html>

Utilisation de Zend_Layout avec le système MVC de Zend Framework

Zend_Controller propose une manière d'étendre ses fonctionnalités au travers de plugins de contrôleur frontal et d'aides d'action. Zend_View propose aussi des aides. Zend_Layout utilise toutes ces possibilités lorsqu'employé avec les composants MVC.

Zend_Layout::startMvc() crée une instance de Zend_Layout avec des paramètres de configuration optionnels. Cette méthode enregistre aussi un plugin de contrôleur frontal qui s'occupe du rendu du layout rempli, lorsque la boucle de distribution est terminée. Elle enregistre également une aide d'action qui permet aux actions d'accéder à l'objet layout. Enfin, l'aide de vue layout, elle, donne accès à l'objet layout depuis la vue.

Regardons d'abord comment initialiser Zend_Layout afin de l'utiliser dans un contexte MVC

// Dans le fichier de démarrage (bootstrap)
Zend_Layout::startMvc();

startMvc() peut prendre en paramètre un tableau d'options ou un objet Zend_Config pour personnaliser l'instance. Ces options sont détaillées dans Zend_Layout options de configuration.

Dans le contrôleur d'action, vous pouvez donc accéder à l'instance de layout via l'aide d'action :

class FooController extends Zend_Controller_Action
{
    public function barAction()
    {
        // désactive les layouts pour cette action
        $this->_helper->layout->disableLayout();
    }
 
    public function bazAction()
    {
        // utilise un script de layout différent pour
        // cette action
        $this->_helper->layout->setLayout('foobaz');
    };
}

Dans vos scripts de vue, utiliser l'aide layout pour accéder à l'instance de Zend_Layout. Notez que cette aide est différente des autres car elle ne retourne pas une chaîne, mais bien un objet. Vous pouvez donc enchaîner une méthode immédiatement :

$this->layout()->setLayout('foo'); // utilise un script de layout spécifique

Autrement, vous pouvez n'importe où accéder à votre instance de Zend_Layout via la méthode statique getMvcInstance() :

// Retourne null si startMvc() n'a pas été appelée auparavant
$layout = Zend_Layout::getMvcInstance();

Enfin, le plugin de contrôleur frontal Zend_Layout dispose d'une caractéristique annexe au rendu automatique du layout : il analyse les segments de l'objet de réponse et les assigne en tant que variables de layout dans vos scripts de layout. Le segment "default" est assigné à la variable "content". Ceci permet de mettre la main sur le contenu rendu dans l'action principale.

Par exemple, supposons que votre code rencontre d'abord FooController::indexAction(), qui va rendre du contenu dans le segment par défaut de la réponse. Ensuite il forward vers NavController::menuAction(), qui rend son contenu dans un segment nommé 'nav'. Enfin, vous forwardez vers CommentController::fetchAction() pour récupérer des commentaires, mais vous les rendez aussi dans le segment par défaut de la réponse (ce qui va rajouter du contenu). Votre script de layout peut alors rendre chaque segment de manière séparée :

<body>
    <!-- rend /nav/menu -->
    <div id="nav"><?php echo $this->layout()->nav ?></div>
 
    <!-- rend /foo/index + /comment/fetch -->
    <div id="content"><?php echo $this->layout()->content ?></div>
</body>

Cette approche est particulièrement utile avec l'aide d'action ActionStack et son plugin du même nom. Vous pouvez les utiliser pour gérer une pile d'actions et ainsi décomposer vos processus.

Utilisation de Zend_Layout en composant indépendant

Pris indépendamment des composants MVC, Zend_Layout n'offre pas tout à fait les mêmes possibilités et la même flexibilité. Cependant, vous bénéficiez de deux avantages :

Des variables propres aux layouts.
Isolation du script de layout, de son contenu issu des scripts de vue.

En tant que composant indépendant, instanciez un objet Zend_Layout, configurez le au moyen d'accesseurs, passez vos variables comme des propriétés de l'objet, et rendez le layout :

$layout = new Zend_Layout();
 
// Spécification du chemin des scripts layout:
$layout->setLayoutPath('/chemin/vers/layouts');
 
// passage de quelques variables :
$layout->content = $content;
$layout->nav     = $nav;
 
// Utilisation d'un script de layout "foo" :
$layout->setLayout('foo');
 
// rendu du layout :
echo $layout->render();

Layout d'exemple

Une image valant mieux qu'un paragraphe, voyez donc celle-ci qui décrit l'utilisation :

Avec cette approche, vous pouvez régler vos mises en forme CSS. En positionnement absolu, par exemple, vous pourriez rendre la barre de navigation plus tard, en fin. Le mécanisme d'obtention du contenu reste le même cependant.

Introduction

Zend_Layout
Guide de référence du programmeur

Zend_Layout options de configuration

Comments

Posted by: Donbrico on: 2011-04-21 15:47:06 ⁋

Hi, thanks for your doc, but how do you create $layout->nav ?

Posted by: Donbrico on: 2011-04-22 07:31:52 ⁋

Hi, thanks for your doc, but how do you create $layout->nav ?

Posted by: eduardo on: 2011-05-10 02:58:36 ⁋

Muy bien todo, pero como michi creo eso, donde coloco el codigo ? lol

Posted by: Michiel Staessen on: 2011-06-02 21:04:49 ⁋

@Donbrico, you don't. use Zend_Navigation and the navigation helper instead.

Posted by: dsa on: 2011-12-25 17:32:31 ⁋

The most stupid explanation i've ever seen.

What's all the first bla-bla-bal about? What's the first script? Layout? View? What's the difference between "Layout helper" and "layout placeholder helper"?

Posted by: Sumair on: 2011-07-06 13:27:33 ⁋

i want to initialize a layout variable in any of my controller and want to use that variable in layouts

How to do this?

also tell me if there is a way to call a method which will work on each page without calling it in each page controller

Posted by: Sourabh bajaj on: 2011-09-17 11:20:46 ⁋

In my application, the header contains information about the logged in user(His name and profile picture.). But Zend_Auth::getInstance()->getIdentity() method is not working while using in layout. How to do that using zend layouts.???

Posted by: Gildus on: 2011-11-16 03:24:42 ⁋

When you mention:

// In your bootstrap:
Zend_Layout::startMvc();

What's mean?, for example it will be that?:

class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
{
....

protected function _initForLayout()
{
Zend_Layout::startMvc();
return null;
}
...
}

Is that?

Regards

Posted by: Micheal Palmark on: 2011-12-30 12:39:29 ⁋

It is so complicate! and hard to understan! What is the purpose of this document ?

Posted by: kevinq on: 2011-12-30 12:55:47 ⁋

Hi, there are some variables used but there is no explanation about where they are set. Where do the variables called in the head get set? For exalmple, headTitle and headScript. My layout is now being called but I would like to set these.

Posted by: Frank Th on: 2012-02-02 20:29:25 ⁋

you could learn how to use layout on this page:
http://framework.zend.com/manual/en/learning.layout.usage.html#learning.layout.usage.access