Zend Framework - Zend_Layout編

HOME | TOP

■ レイアウトは自前で用意する

Zend_Layoutという名前ではありますが、レイアウト済みの空洞のファイルを必要なパターン数だけ自前で用意しておくことになります。
（デフォルトでlayout.phtmlというファイル名になります。）

この自前で用意したレイアウト済みの空洞ファイルは『レイアウトスクリプト』と呼ばれます。

スクリプトと呼ばれるとおり、レイアウト済みのエリア分けされた空洞位置に、表示させたい内容が反映されるように
<html> <head> <meta http-equiv="Content-type" content="text/html; charset=Shift_JIS"> <link rel="stylesheet" type="text/css" href="/css/common.css"> <title><?php echo $this->escape($this->title);?></title> <script type="text/javascript" charset="UTF-8" src="//cache1.value-domain.com/xrea_header.js" async="async"></script> </head> <body> <h1><?php echo $this->escape($this->title);?></h1> <?php echo $this->layout()->menu;?> <hr> <?php echo $this->layout()->content;?> <hr>(C) 2010 全土太郎 </body> </html>
のように書いておくことになります。

Zend_Layoutも当然レンダリングするので内部でZend_Viewを使っていることになります。
なのでビュースクリプトで使えるビューヘルパ類はそのまま使えます。
サイト内の複数のページを同じレイアウトにしたい場合には同じレイアウトスクリプトを呼び出せばいいということになります。

■ Zend_Layoutを使ってみる

▽ ＭＶＣを使わない場合のZend_Layoutの使い方

まずはいつものようにクラスからオブジェクトを作成（new演算子を使う）してみます。
実行スクリプト [htdocs/index.php] <?php require_once 'Zend/Layout.php'; $layout = new Zend_Layout(); // オブジェクト作成 $layout->setLayoutPath('.'); // レイアウトスクリプト置き場を教える $layout->setLayout('foo'); // レイアウトスクリプト指定（デフォルトはlayout） $layout->getView()->setEncoding('sjis'); // sjis設定 // 置き換えコンテンツを代入 $layout->header = 'へっだー'; $layout->content = 'はろーわーるど'; echo $layout->render(); // レンダリングして結果を表示
そのままではレイアウトスクリプトの置き場所がわからないのでsetLayoutPath()メソッドを使って教えることになります。

デフォルトではレイアウトスクリプトとして使われるファイル名がlayout.phtmlになっているのでこれを変更したい場合にはsetLayout()を使って変えることができるようになっています。
また、拡張子も変えたい場合にはsetViewSuffix()メソッドを使えばできます。

レイアウトスクリプト [htdocs/foo.phtml] <body> <h1><?php echo $this->escape($this->layout()->header);?></h1> <?php echo $this->layout()->content;?> </body>
「$this->layout()->変数名」という形式で値参照できます。

一連の処理としてはこんな感じになります。あとはいい感じのレイアウトを用意できるかどうかはあなた次第といったことろです。

▽ ＭＶＣを使う場合のZend_Layoutの使い方

先ほどはＭＶＣを使わないシンプルな使い方でしたが、今度はＭＶＣでZend_Layoutを使ってしまおうというお話です。
フロントコントローラ [htdocs/index.php] <?php require_once 'Zend/Controller/Front.php'; require_once 'Zend/Layout.php'; $front = Zend_Controller_Front::getInstance(); // インスタンスを作成してレイアウトスクリプト置き場を教える Zend_Layout::startMvc(array('layoutPath' => '../application/views/layouts')); $front->setControllerDirectory('../application/controllers'); $front->dispatch();
ＭＶＣで使う場合はその処理構造から、
フロントコントローラ（index.php）で設定にまつわるレイアウトスクリプト置き場を教えて、実質的な処理をするアクション側ではオブジェクトを取得してなんやかんやちょっかい出していく感じになるので、オブジェクトの作成自体はフロントコントローラで作成して教えたレイアウトスクリプト置き場の値を保持してもらうことになります。

それを行うのがstartMvc()という静的メソッドになります。

アクションコントローラ [application/controllers/IndexController.php] <?php require_once 'Zend/Controller/Action.php'; class IndexController extends Zend_Controller_Action { public function init() { $this->view->setEncoding('sjis'); $this->view->title = '宇宙小話十番勝負'; $this->_helper->layout->setLayout('layout01'); // レイアウトスクリプト指定 $this->_helper->layout->header = $this->view->render('index/header.phtml'); } public function indexAction() { // index/index.phtmlの内容は、レイアウトスクリプト側から // $this->layout()->contentで値参照できるようになります } public function changelayoutAction() { // index/changelayout.phtmlの内容は、レイアウトスクリプト側から // $this->layout()->contentで値参照できるようになります $this->_helper->layout->setLayout('layout02'); // レイアウトを変える // レイアウトスクリプト側から$this->layout()->contentで参照される値を // index/content02.phtmlの内容に切り替える $this->render('content02'); } }
「$this->_helper->layout」とすることでフロントコントローラで作成したレイアウトオブジェクトにいきなりアクセスできるようになっています。
これはアクションヘルパーが助けてくれているのでできることですが、もし別の方法でレイアウトオブジェクトを取得するとしたら

$layout = Zend_Layout::getMvcInstance();

を使うことになります。

ビュースクリプト [application/views/scripts/index/index.phtml] <div class="content">indexアクションのコンテンツ</div>
この内容が丸々レイアウトスクリプトのメンバ変数「$this->layout()->content」位置に置き換えられることになります。

レイアウトスクリプト [application/views/layouts/layout01.phtml] <html> <head> <meta http-equiv="Content-type" content="text/html; charset=Shift_JIS"> <link rel="stylesheet" type="text/css" href="/css/common.css"> <title><?php echo $this->escape($this->title);?></title> <script type="text/javascript" charset="UTF-8" src="//cache1.value-domain.com/xrea_header.js" async="async"></script> </head> <body> <h1><?php echo $this->escape($this->title);?></h1> <?php echo $this->layout()->menu;?> <hr> <?php echo $this->layout()->content;?> <hr>(C) 2010 全土太郎 </body> </html>
すでに書きましたが、「$this->layout()->変数名」で値参照することになります。ビューヘルパー類も使えます。

個別に置き換えたいmenuと、アクションごとの内容として置き換えたいcontentなど、レイアウト済みのエリア分けされた部分にいろいろと置き換えているのが分かります。

言うなれば最終的に表示させるＨＴＭＬソースの設計図といった感じですかね。

■ レイアウト処理の本質を考える

１サイトの持つページ間では <html> <head> <meta http-equiv="Content-type" content="text/html; charset=Shift_JIS"> <link rel="stylesheet" type="text/css" href="/css/common.css"> <title></title> <script type="text/javascript" charset="UTF-8" src="//cache1.value-domain.com/xrea_header.js" async="async"></script> </head> <body> </body> </html>
ＨＴＭＬ文書に使っている文字コード、スタイルシートはだいたい共通しています。

更に突き進めていくと、

<html> <head> <meta http-equiv="Content-type" content="text/html; charset=Shift_JIS"> <link rel="stylesheet" type="text/css" href="/css/common.css"> <title>マナカナの見分け方</title> <script type="text/javascript" charset="UTF-8" src="//cache1.value-domain.com/xrea_header.js" async="async"></script> </head> <body> <h1>マナカナの見分け方</h1> <div id="menu"> </div> <div id="content"></div> <hr>(C) 2010 全土太郎 </body> </html>
タイトルやレイアウト、フッターといった共通部分がページ間にある場合が多いことがわかります。

ここまで共通してくると、ページ間に統一性があることでサイト全体のまとまった感や色合いが醸し出せると思います。

要はZend_Layoutのやってることは、サイトで使用するレイアウトのパターン数だけページを用意しておくことでページ間で共通の部分をくくり出しておき、ページごとに変わるコンテンツ部分のみを入れ替えるだけにするための処理であると言えると思います。

そう考えると少し疑問がわいてきます。

なぜＭＶＣでビュースクリプトを使っているのにわざわざレイアウトスクリプトまで使う必要があるのかと・・・
これって二度手間ってやつじゃないかと・・・

考えてみたらアクション処理後に呼び出されるビュースクリプトは、デフォルトだと「application/views/scripts/ｺﾝﾄﾛｰﾗ名/ｱｸｼｮﾝ名.phtml」になります。
このビュースクリプトには当然レイアウトスクリプトのようにレイアウトを書いておくことができるわけです。

ただ、それをやるとアクションの数だけレイアウトを書いたビュースクリプトを用意しなければいけなくなってしまいます。
できればレイアウトは一箇所にくくり出して集約させたい。
１パターンのレイアウトは１ファイルで収めたいということになります。

そこでかゆいところはかいてあげますよと言わんばかりに登場したのがZend_Layoutということになるでしょう。

でもよくよく考えてみたらこれってアクションとビュースクリプトの関係を使えばZend_Layoutと同じようなことが簡単にできるんじゃないの？

という疑問がわいたので考えてみました。

[application/controllers/IndexController.php] <?php require_once 'Zend/Controller/Action.php'; class IndexController extends Zend_Controller_Action { private $_content = 'index'; private $_layout = 'layout01'; public function init() { // ディスパッチされるアクション名を代入 $this->_content = $this->getRequest()->getActionName(); } public function indexAction() // デフォルトのアクションメソッド { // index/index.phtmlにレイアウト抜きの"index"コンテンツを記述 } public function fooAction() // "foo"アクション { // index/foo.phtmlにレイアウト抜きの"foo"コンテンツを記述 } public function barAction() // "bar"アクション { // index/bar.phtmlにレイアウト抜きの"bar"コンテンツを記述 } public function changelayoutAction() // ちょいとレイアウトを変えたいページ { $this->_layout = 'layout02'; // 別レイアウト指定 // index/changelayout.phtmlにレイアウト抜きの"changelayout"コンテンツを記述 } public function postDispatch() { $this->view->menu = $this->view->render('index/menu.phtml'); $this->view->content = $this->view->render('index/' . $this->_content . '.phtml'); $this->render($this->_layout); // レイアウトを指定して描き上げる } }

こんな感じで書けばZend_Layoutと同様のことができると思うので、二度手間にならない気がします。

アクションメソッド内およびそれに対応するビュースクリプトでは、レイアウトされたページ内に表示させる１エリアとしてのコンテンツ処理に集中できるということになります。

もちろん、もっと広くアクションコントローラを飛び越えてレイアウトを共有したい場合にはアクションヘルパーを自作することでできると思います。

そう考えると初めは便利だと思っていたZend_Layoutって必要なのか？と思えてきます。
いやむしろＭＶＣの方が強力な処理構造になっていて凄すぎると言ったほうがいいかも知れません。

よりシンプルで頑丈なアプリケーション作りを目指すわたし的結論としては、Zend_Layoutを使うとしたらＭＶＣ以外で使うという考えに帰結しました。（なぜかZend_LayoutにはMVCを使う感バリバリのメソッド名が用意されてはいますが）

2010(C)Mingw