Programmer's Reference Guide

導入

Zend_Layout クイックスタート

Zend_Layout の使用法は大きくふたつに分けられます。 Zend Framework の MVC を使用する方法とそれ以外の方法です。

レイアウトスクリプト

どちらにしても、まずはレイアウトスクリプトを作成しなければなりません。レイアウトスクリプトは、単純に Zend_View (あるいはその他のあなたが使用しているビュー実装) を用いて作成します。レイアウト変数の登録には Zend_Layout のプレースホルダを使用します。プレースホルダへのアクセスは、プレースホルダヘルパーを使用するか、あるいはレイアウトヘルパーのレイアウトオブジェクトのプロパティを使用します。

たとえばこのようになります。

<!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>私のサイト</title>
</head>
<body>
<?php
    // レイアウトヘルパーで使用するコンテンツのキーを取得します
    echo $this->layout()->content;
 
    // プレースホルダヘルパーで 'foo' キーを取得します
    echo $this->placeholder('Zend_Layout')->foo;
 
    // レイアウトオブジェクトを取得し、そこから変数のキーを取得します
    $layout = $this->layout();
    echo $layout->bar;
    echo $layout->baz;
?>
</body>
</html>

Zend_Layout は Zend_View を用いてレンダリングをしているので、登録されているビューヘルパーはすべて使用できます。またビューに登録されている変数も使用できます。特に便利なのは、さまざまなプレースホルダヘルパーを使用できることでしょう。これらを用いると、たとえば <head> セクションやナビゲーション部などのコンテンツを取得できます。

<!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>

Zend_Layout を Zend Framework の MVC で使用する方法

Zend_Controller には拡張用の機能が豊富に用意されています。これはフロントコントローラプラグインやアクションコントローラヘルパーによって実現されているものです。 Zend_View にもヘルパーは存在します。 Zend_Layout を MVC コンポーネントとともに使用すると、これらのさまざまな拡張ポイントの恩恵を受けることになります。

Zend_Layout::startMvc() は、オプションの設定項目を指定して Zend_Layout のインスタンスを作成します。そして、フロントコントローラプラグインを登録し、ディスパッチループの終了後にレイアウトの中身をレンダリングするようにします。また、アクションヘルパーを登録して、アクションコントローラからレイアウトオブジェクトにアクセスできるようにします。さらに、ビュースクリプトからレイアウトのインスタンスを取得するには Layout ビューヘルパーを使用します。

まずは、MVC と組み合わせるための Zend_Layout のインスタンスの作成方法を見てみましょう。

// 起動ファイル内で
Zend_Layout::startMvc();

startMvc() には、オプションの配列あるいは Zend_Config オブジェクトを渡すことができます。これによってインスタンスをカスタマイズします。オプションの詳細についてはこの節を参照ください。

アクションコントローラからは、アクションヘルパーでレイアウトのインスタンスにアクセスします。

class FooController extends Zend_Controller_Action
{
    public function barAction()
    {
        // このアクションではレイアウトを無効にします
        $this->_helper->layout->disableLayout();
    }
 
    public function bazAction()
    {
        // このアクションでは別のレイアウトスクリプトを使用します
        $this->_helper->layout->setLayout('foobaz');
    };
}

ビュースクリプトでは、Layout ビューヘルパーを用いてレイアウトオブジェクトにアクセスします。このビューヘルパーは、他のヘルパーとは異なり引数を受け取りません。そして文字列ではなくオブジェクトを返します。これにより、レイアウトオブジェクトのメソッドをすぐにコールできるようになります。

<?php $this->layout()->setLayout('foo'); // 別のレイアウトを設定します ?>

MVC に登録した Zend_Layout のインスタンスを取得するには、静的メソッド getMvcInstance() を使用します。

// startMvc() がまだコールされていない場合は null を返します
$layout = Zend_Layout::getMvcInstance();

最後に、Zend_Layout のフロントコントローラプラグインが持つ、レイアウトのレンダリング以外の重要な機能をひとつ紹介します。レスポンスオブジェクトから名前つきセグメントをすべて取得し、それをレイアウトの変数に代入するというものです。このとき 'default' セグメントは 'content' という名前の変数に代入します。これにより、アプリケーションのコンテンツにアクセスしてそれをビュースクリプト内でレンダリングできるようになります。

たとえば、こんな例を考えてみましょう。あなたの書いたコードがまず FooController::indexAction() を実行し、デフォルトのレスポンスセグメントに何らかのコンテンツをレンダリングしてから NavController::menuAction() に転送します。ここでは、レンダリングしたコンテンツをレスポンスセグメント 'nav' に格納します。最後に CommentController::fetchAction() に転送してコメントを取得しますが、その内容はデフォルトのレスポンスセグメントに (追記する方式で) レンダリングします。そして、ビュースクリプト側ではそれを個別にレンダリングします。

<body>
    <!-- /nav/menu のレンダリング -->
    <div id="nav"><?php echo $this->layout()->nav ?></div>
 
    <!-- /foo/index + /comment/fetch のレンダリング -->
    <div id="content"><?php echo $this->layout()->content ?></div>
</body>

この機能は、ActionStack アクションヘルパーやプラグインと組み合わせて使うと非常に便利です。アクションのスタックを作成してそれをループさせ、ウィジェット形式のページを作成するというわけです。

Zend_Layout を単体のコンポーネントとして使用する方法

単体のコンポーネントとして使用した場合は、Zend_Layout を MVC に組み込んだ場合に使用できる機能のほとんどが使えなくなります。しかし、それでも次のふたつのメリットがあります。

レイアウト変数のスコープの管理。
レイアウトビュースクリプトとその他のビュースクリプトの分離。

単体のコンポーネントとして使用するには、単純にレイアウトオブジェクトのインスタンスを作成して各種アクセサで状態を設定し、オブジェクトのプロパティに変数を設定してからレイアウトをレンダリングします。

$layout = new Zend_Layout();
 
// レイアウトスクリプトのパスを設定します
$layout->setLayoutPath('/path/to/layouts');
 
// 変数を設定します
$layout->content = $content;
$layout->nav     = $nav;
 
// 別のレイアウトスクリプトを選択します
$layout->setLayout('foo');
 
// 最終的なレイアウトをレンダリングします
echo $layout->render();

サンプルレイアウト

一枚の絵のほうがが千の言葉よりも雄弁なこともあります。これは、サンプルのレイアウトスクリプトをすべてまとめたときにどのように表示されるのかを示すものです。

実際の要素の並び順は、使用する CSS によってさまざまに異なります。たとえば、絶対位置指定を用いれば、ナビゲーション部を本文よりも後に表示させても上部に表示させることができるでしょう。同じことが、サイドバーやヘッダにもいえます。しかし、そのコンテンツを作り出すもとの仕組みは同じです。

導入

Zend_Layout
プログラマ向けリファレンスガイド

Zend_Layout の設定オプション

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