Previous Next

Zend_Layout クイックスタート

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

レイアウトスクリプト

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

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




    
    私のサイト


layout()->content; 

    // プレースホルダヘルパーで 'foo' キーを取得します
    echo $this->placeholder('Zend_Layout')->foo;

    // レイアウトオブジェクトを取得し、そこから変数のキーを取得します
    $layout = $this->layout();
    echo $layout->bar;
    echo $layout->baz;
?>

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




    
    headTitle() ?>
    headScript() ?>
    headStyle() ?>


    render('header.phtml') ?>

    

    
layout()->content ?>
render('footer.phtml') ?>

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 オブジェクトを渡すことができます。 これによってインスタンスをカスタマイズします。 オプションの詳細については Zend_Layout の設定オプション を参照ください。

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

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

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

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

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

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

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

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

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


    
    

    
    
layout()->content ?>

この機能は、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();

サンプルレイアウト

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

zend.layout.quickstart.example.png

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

Previous Next
Introduction to Zend Framework
概要
インストール
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
Zend_Captcha
導入
Captcha の方法
Captcha アダプタ
Zend_Config
導入
動作原理
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Getopt について
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
以前のバージョンからの移行
Zend_Currency
Zend_Currency について
通貨の操作方法
以前のバージョンからの移行
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
導入
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojo Form Elements and Decorators
Zend_Dom
導入
Zend_Dom_Query
Zend_Exception
例外の使用法
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_File
Zend_File_Transfer
Zend_File_Transfer 用のバリデータ
Filters for Zend_File_Transfer
以前のバージョンからの移行
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
Gdata について
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
Zend_Http_Client - 導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
JSON オブジェクト
XML から JSON への変換
Zend_Json_Server - JSON-RPC server
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
Zend_Loader
ファイルやクラスの動的な読み込み
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
サポートするロケール
以前のバージョンからの移行
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ドキュメントのページ
描画
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Server
導入
Zend_Server_Reflection
Zend_Service
導入
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
導入
Zend_Service_StrikeIron
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Accessor
AutoDiscovery
Zend_Test
導入
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
Migrating from previous versions
Zend_Uri
Zend_Uri
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework のシステム要件
PHP のバージョン
PHP の拡張モジュール
Zend Framework のコンポーネント
Zend Framework の依存性
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework Performance Guide
Introduction
Class Loading
Internationalization (i18n) and Localization (l10n)
View Rendering
著作権に関する情報