Previous Next

Zend Framework に同梱されている標準のデコレータ

Zend_Form には、標準でいくつかのデコレータが組み込まれています。 デコレータの一般的な使用法については デコレータの説明 を参照ください。

Zend_Form_Decorator_Callback

Callback デコレータは、コンテンツをレンダリングする際に任意のコールバックを実行します。 コールバックは、デコレータのオプション 'callback' で指定します。 PHP のコールバック型の値を指定することができます。 指定するコールバックは、3 つの引数 $content (デコレータに渡されたコンテンツ)、 $element (処理する項目)、 $options (オプションの配列) を受け取るものでなければなりません。 コールバックの例は、次のようになります。

class Util
{
    public static function label($content, $element, array $options)
    {
        return '' . $element->getLabel() . "";
    }
}

このコールバックは array('Util', 'label') のように指定します。 そして、ラベル用の (間違った) HTML マークアップを生成します。 Callback デコレータはコンテンツの内容を書き換えることもできますし、 コンテンツの前後に文字列を追加することもできます。

Callback デコレータの placement オプションに null 値を指定すると、 元のコンテンツをコールバックの返り値で上書きします。 'prepend' や 'append' を指定した場合も正しく動作します。

Zend_Form_Decorator_Captcha

Captcha デコレータは Captcha フォーム要素 と組み合わせて使用します。 これは、captcha アダプタの render() メソッドを使用して出力を生成します。

Captcha デコレータの別版である 'Captcha_Word' もよく用いられます。 これは id と input のふたつの要素を作成します。 id は比較対象のセッション識別子、そして input captcha のユーザ入力を表します。 これらは単一の要素として検証されます。

Zend_Form_Decorator_Description

Description デコレータは Zend_FormZend_Form_Element あるいは Zend_Form_DisplayGroup の説明を表示します。 説明は、各オブジェクトの getDescription() メソッドで取得します。 各要素の操作説明を提供するためなどに使用します。

デフォルトでは、説明が存在しない場合は何も出力を生成しません。 説明が存在する場合は、デフォルトではそれを HTML の p タグで囲んで表示します。このタグを変更するには、 デコレータを作成する際にオプション tag を渡すか、あるいは setTag() をコールします。 さらに、そのタグにクラスを指定することもできます。これは、オプション class あるいはメソッド setClass() で指定します。 デフォルトで使用するクラスは 'hint' です。

説明は、デフォルトでビューオブジェクトのエスケープ機構を使って エスケープされます。これを無効にするには、デコレータのオプション 'escape' に false を渡すか、あるいは setEscape() メソッドをコールします。

Zend_Form_Decorator_DtDdWrapper

デフォルトのデコレータで、フォームの要素を定義リスト (<dl>) を用いて装飾します。 フォームの項目は任意の順序であらわれるので、 表示グループやサブフォームがその他のフォーム項目の中に点在することがあり得ます。 表示グループやサブフォームなどの特定の項目を定義リスト内でも保持するために、 DtDdWrapper は新しい空の用語定義 (<dt>) を作成し、コンテンツを新しい定義データ (<dd>) としてラップします。出力は、次のようになります。

User Information ...

このデコレータは、元のコンテンツを上書きし、 <dd> 要素でラップしたもので置き換えます。

Zend_Form_Decorator_Errors

要素のエラーを処理するのが Errors デコレータです。 このデコレータは FormErrors ビューヘルパーへのプロキシとなり、 エラーメッセージを順序なしリスト (<ul>) にレンダリングします。 <ul> 要素のクラスは "errors" となります。

Errors デコレータは、元のコンテンツの先頭あるいは末尾に文字列を追加します。

Zend_Form_Decorator_Fieldset

グループやサブフォームの内容を、デフォルトで fieldset の中にレンダリングします。 Fieldset デコレータは、オプション 'legend' の内容あるいは要素の getLegend() メソッドの内容を確認し、 何かが指定されていればそれを legend として使用します。 渡されたコンテンツは HTML の fieldset でラップされ、 その内容で元のコンテンツを上書きします。 元の項目に設定されていた属性は、すべて fieldset の HTML 属性として設定されます。

Zend_Form_Decorator_File

File 要素には特殊な記法があり、 複数の file 要素やサブフォームを利用する際にそれを使用します。 File デコレータは Zend_Form_Element_File が使用するもので、複数の file 要素を一度のメソッドコールで設定することができます。 自動的に使用され、要素名を自動的に修正します。

Zend_Form_Decorator_Form

Zend_Form オブジェクトは HTML の form タグをレンダリングするものです。 Form デコレータは Form ビューヘルパーへのプロキシとなります。 これは、渡されたコンテンツを HTML の form 要素でラップします。 その際に Zend_Form オブジェクトの action や method、 そして属性を使用します。

Zend_Form_Decorator_FormElements

フォームや表示グループ、サブフォームはいくつかの要素のコレクションです。 これらの要素をレンダリングする際には FormElements デコレータを使用します。 これは、各構成要素を順次処理して個別に render() をコールし、登録されている区切り文字で結果を連結します。 このデコレータは、元のコンテンツの先頭あるいは末尾に文字列を追加します。

Zend_Form_Decorator_HtmlTag

HtmlTag デコレータは、HTML タグを使ってコンテンツを装飾します。 使用するタグを 'tag' オプションで指定します。 それ以外に指定したオプションは、そのタグの属性として用いられます。 デフォルトのタグはブロックレベルのものであり、 指定したタグでコンテンツをラップして元のコンテンツを上書きします。 しかし、placement に append あるいは prepend を指定することもできます。

Zend_Form_Decorator_Image

Image デコレータは、HTML の image input (<input type="image" ... />) を作成し、オプションでそれを他の HTML タグの中にレンダリングします。

デフォルトでは、このデコレータは要素の src プロパティを使用します。 これは、setImage() で画像ソースとして指定することができます。 さらに、要素のラベルは alt タグとして使用します。また imageValue (Image 要素のアクセサ setImageValue() および getImageValue() で操作します) を値として使用します。

この要素をラップする HTML タグを指定するには、デコレータのオプション 'tag' を指定するか、あるいは setTag() をコールします。

Zend_Form_Decorator_Label

フォーム要素には通常ラベルがあります。Label デコレータは、このラベルをレンダリングするものです。 FormLabel ビューヘルパーへのプロキシとして働き、 要素の getLabel() メソッドを使用してラベルを取得します。 ラベルが存在しない場合は、何もレンダリングしません。 デフォルトでは、翻訳アダプタが存在して ラベルの翻訳が存在する場合には、ラベルの翻訳を行います。

オプション 'tag' を指定することもできます。 指定した場合は、そのブロックレベルタグでラベルをラップします。 'tag' が指定されているがラベルが存在しないという場合は、 指定したタグを中身なしでレンダリングします。 このタグにクラスを指定するには、オプション 'class' を指定するか、あるいは setClass() をコールします。

さらに、要素の表示の際に使用するプレフィックスおよびサフィックスを指定することもできます。 これは、任意要素のラベルか必須要素のラベルかを表す際などに使用します。 一般的な使用法は、ラベルの最後に ':' を追加したり 必須項目に '*' を追加したりといったものです。 次のようなオプションやメソッドを使用します。

  • optionalPrefix: その要素がオプション要素である場合にラベルの先頭に付加するテキストを設定します。 setOptionalPrefix() および getOptionalPrefix() で操作します。

  • optionalSuffix: その要素がオプション要素である場合にラベルの末尾に付加するテキストを設定します。 setOptionalSuffix() および getOptionalSuffix() で操作します。

  • requiredPrefix: その要素が必須要素である場合にラベルの先頭に付加するテキストを設定します。 setRequiredPrefix() および getRequiredPrefix() で操作します。

  • requiredSuffix: その要素が必須要素である場合にラベルの末尾に付加するテキストを設定します。 setRequiredSuffix() および getRequiredSuffix() で操作します。

デフォルトでは、Label デコレータは元のコンテンツの先頭に結果を追加します。 'placement' オプションを 'append' にすると、 コンテンツの末尾に追加することができます。

Zend_Form_Decorator_ViewHelper

大半の要素のレンダリングには Zend_View ヘルパーを使用します。これを行うのが ViewHelper デコレータです。 このデコレータでは、'helper' タグで明示的にビューヘルパーを指定することができます。 指定しなかった場合は、要素のクラス名の最後の部分をもとに使用するヘルパーを決定します。 この最後の部分の先頭に 'form' をつけたものを使います。 たとえば 'Zend_Form_Element_Text' の場合は 'formText' というビューヘルパーを探すことになります。

渡された要素のすべての属性は、要素の属性としてビューヘルパーに渡されます。

デフォルトでは、このデコレータはコンテンツの末尾に結果を追加します。 'placement' オプションを指定すれば、先頭に追加させることもできます。

Zend_Form_Decorator_ViewScript

ビュースクリプトを使用して要素を作成したくなることもあるでしょう。 これにより、作成する要素をよりきめ細やかに設定できるようになります。 またビュースクリプトでデザインを行ったり 使用するモジュールにあわせて設定を簡単にオーバーライドしたりできるようになります (各モジュールで、要素のビュースクリプトを必要に応じてオーバーライドすることができます)。 ViewScript デコレータが、この問題を解決します。

ViewScript デコレータには 'viewScript' オプションが必須です。 これは、デコレータ側で指定するか、あるいは要素の属性で指定します。 そのビュースクリプトをパーシャルスクリプトとしてレンダリングします。 各コールごとに独自の変数スコープを保持するので、 その要素の変数以外にビューからの変数が注入されることはありません。 いくつかの変数が設定されます。

  • element: デコレートする要素の名前

  • content: デコレータに渡されたコンテンツ

  • decorator: デコレータオブジェクト自身

  • さらに、デコレータに setOptions() で渡されたすべてのオプションのうち内部的に使用しないもの (placement や separator など) は、 ビュースクリプトにビュー変数として渡されます。

例として、次のような要素を考えてみましょう。

// 要素のデコレータとして、ViewScript デコレータを指定し、
// ビュースクリプトとその他のオプションを設定します
$element->setDecorators(array(array('ViewScript', array(
    'viewScript' => '_element.phtml',
    'class'      => 'form element'
))));

// あるいはビュースクリプトを要素の属性として指定します
$element->viewScript = '_element.phtml';
$element->setDecorators(array(array('ViewScript',
                                    array('class' => 'form element'))));

そして、次のようなビュースクリプトを作成します

formLabel($this->element->getName(), $this->element->getLabel()) ?> {$this->element->helper}( $this->element->getName(), $this->element->getValue(), $this->element->getAttribs() ) ?> formErrors($this->element->getMessages()) ?>
element->getDescription() ?>

Note: ビュースクリプトによるコンテンツの置換

デコレータに渡されたコンテンツをビュースクリプトで置換したいこともあるでしょう。 たとえばコンテンツをラップしたい場合などです。 その場合は、デコレータのオプション 'placement' に false を設定します。

// デコレータの作成時
$element->addDecorator('ViewScript', array('placement' => false));

// 既存のデコレータインスタンスへの適用
$decorator->setOption('placement', false);

// 既に要素にアタッチされているデコレータへの適用
$element->getDecorator('ViewScript')->setOption('placement', false);

// デコレータが使用するビュースクリプト内
$this->decorator->setOption('placement', false);

ViewScript デコレータは、 要素のレンダリングをよりきめ細やかに設定したい場合に使用することをおすすめします。

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
著作権に関する情報