Previous Next

Zend_Form_Decorator による独自のフォームマークアップの作成

フォームオブジェクトのレンダリングは、完全に別の処理です。 Zend_Form の render() メソッドを使わなくてもかまいません。 しかし、もし使う場合は フォームオブジェクトのレンダリングにはデコレータを使用します。

任意の数のデコレータを各項目 (要素、表示グループ、サブフォーム、あるいはフォームオブジェクト自体) にアタッチすることができます。しかし、 同じ型のデコレータは各項目にひとつだけしかアタッチすることができません。 デコレータは、登録した順にコールされます。 デコレータの種類によっては、渡されたコンテンツを書き換えたり 前後にコンテンツを追加したりするものもあります。

オブジェクトの状態を設定するには、コンストラクタあるいは デコレータの setOptions() メソッドにオプションを渡します。 各項目の addDecorator() 系のメソッドでデコレータを作成する際には、 そのメソッドの引数でオプションを指定することができます。 これを使用して、配置方法や区切り文字などのデコレータ用オプションを指定します。

各デコレータの render() メソッドがコールされる前に、 setElement() を使用して現在の項目がデコレータに設定されます。 これで、デコレータがレンダリングすべき項目を知ることができるようになります。 これを使用すると、特定の部分 (ラベルや値、エラーメッセージなど) だけをレンダリングするデコレータを作成することができます。 複数のデコレータにそれぞれ個別の部分をレンダリングさせた結果をまとめることで、 ひとつの項目に対して複雑なマークアップを行うことができます。

操作方法

デコレータを設定するには、オプションの配列あるいは Zend_Config オブジェクトをコンストラクタに渡します。 あるいは、配列を setOptions() に渡したり Zend_Config オブジェクトを setConfig() に渡すことでも設定できます。

標準のオプションは次のとおりです。

  • placement: 配置方法を 'append' あるいは 'prepend' (大文字小文字は区別しません) で指定します。 これは、render() に渡されたコンテンツを 先頭に追加するのか末尾に追加するのかを表します。 デコレータがコンテンツを書き換えるときは、この設定は無視されます。 デフォルトの設定は append (末尾に追加する) です。

  • separator: 区切り文字を指定します。 これは、render() に渡されたコンテンツと デコレータが新たに作成したコンテンツの区切りとして使用します。 あるいはデコレータがレンダリングする各項目の区切りにも使用します (たとえば、FormElements は各項目の区切りにこの文字を使用します)。 デコレータがコンテンツを書き換えるときは、この設定は無視されます。 デフォルト値は PHP_EOL です。

デコレータのインターフェイスの中にはオプションを操作するメソッドも用意されています。 以下にそれをまとめます。

  • setOption($key, $value): 単一のオプションを設定します。

  • getOption($key): 単一のオプションの値を取得します。

  • getOptions(): すべてのオプションを取得します。

  • removeOption($key): 単一のオプションを削除します。

  • clearOptions(): すべてのオプションを削除します。

デコレータは、 Zend_Form のさまざまなクラスで使用できるようになっています。 Zend_FormZend_Form_ElementZend_Form_DisplayGroup、 そしてその派生クラスのすべてで使用することができます。 setElement() メソッドを使用すると、 デコレータが処理するオブジェクトを指定することができます。一方 getElement() で、現在処理中のオブジェクトを取得することができます。

各デコレータの render() メソッドの引数 $content には文字列が渡されます。 最初のデコレータがコールされたときは、通常はこの文字列は空です。 それ以降のコールの際に、内容が書き込まれていきます。 デコレータの型やオプションに応じて、デコレータはコンテンツを書き換えたり コンテンツの前後に文字列を追加したりします。 前後に文字列を追加するときには、オプションで指定した区切り文字を使用します。

標準のデコレータ

Zend_Form には、多くのデコレータが標準で組み込まれています。 詳細は 標準のデコレータについての章 を参照ください。

独自のデコレータ

複雑なレンダリングを要したり大幅なカスタマイズが必要な場合は、 独自のデコレータを自作することを考えてみましょう。

デコレータに必要なのは、Zend_Decorator_Interface を実装することだけです。このインターフェイスの定義は次のようになります。

interface Zend_Decorator_Interface
{
    public function __construct($options = null);
    public function setElement($element);
    public function getElement();
    public function setOptions(array $options);
    public function setConfig(Zend_Config $config);
    public function setOption($key, $value);
    public function getOption($key);
    public function getOptions();
    public function removeOption($key);
    public function clearOptions();
    public function render($content);
}

よりお手軽に作成するには、Zend_Decorator_Abstract を継承したクラスを作成します。このクラスは、 render() 以外のすべてのメソッドを実装しています。

たとえば、使用するデコレータの数を減らすために "複合" デコレータを作成することにしましょう。 このデコレータでは、ラベルや要素、エラーメッセージ、 そして説明を HTML の div でレンダリングします。 この 'Composite' デコレータは、次のようになります。

class My_Decorator_Composite extends Zend_Form_Decorator_Abstract
{
    public function buildLabel()
    {
        $element = $this->getElement();
        $label = $element->getLabel();
        if ($translator = $element->getTranslator()) {
            $label = $translator->translate($label);
        }
        if ($element->isRequired()) {
            $label .= '*';
        }
        $label .= ':';
        return $element->getView()
                       ->formLabel($element->getName(), $label);
    }

    public function buildInput()
    {
        $element = $this->getElement();
        $helper  = $element->helper;
        return $element->getView()->$helper(
            $element->getName(),
            $element->getValue(),
            $element->getAttribs(),
            $element->options
        );
    }

    public function buildErrors()
    {
        $element  = $this->getElement();
        $messages = $element->getMessages();
        if (empty($messages)) {
            return '';
        }
        return '
' . $element->getView()->formErrors($messages) . '
'; } public function buildDescription() { $element = $this->getElement(); $desc = $element->getDescription(); if (empty($desc)) { return ''; } return '
' . $desc . '
'; } public function render($content) { $element = $this->getElement(); if (!$element instanceof Zend_Form_Element) { return $content; } if (null === $element->getView()) { return $content; } $separator = $this->getSeparator(); $placement = $this->getPlacement(); $label = $this->buildLabel(); $input = $this->buildInput(); $errors = $this->buildErrors(); $desc = $this->buildDescription(); $output = '
' . $label . $input . $errors . $desc . '
' switch ($placement) { case (self::PREPEND): return $output . $separator . $content; case (self::APPEND): default: return $content . $separator . $output; } } }

そして、これをデコレータのパスに配置します。

// 特定の要素向け
$element->addPrefixPath('My_Decorator',
                        'My/Decorator/',
                        'decorator');

// すべての要素向け
$form->addElementPrefixPath('My_Decorator',
                            'My/Decorator/',
                            'decorator');

そうすれば、このデコレータを 'Composite' として要素にアタッチすることができるようになります。

// 既存のデコレータをこのひとつで置き換えます
$element->setDecorators(array('Composite'));

この例では複数の要素のプロパティをもとに複雑な出力を作成するデコレータの 作り方を示しましたが、要素の特定の側面だけを扱うようなデコレータを作成することもできます。 'Decorator' デコレータや 'Label' デコレータなどは、 この方式のすばらしい例です。 このようにしておけば、複数のデコレータを組み合わせて 複雑な出力を作成することができます。 と同時に、必要に応じて出力の一部だけをオーバーライドすることもできるわけです。

たとえば、要素の検証でエラーが発生したことだけをシンプルに表示して、 各要素の個別の検証エラーメッセージは表示しないようにしたい場合は、 独自の 'Errors' デコレータを作成します。

class My_Decorator_Errors
{
    public function render($content = '')
    {
        $output = '
The value you provided was invalid; please try again
'; $placement = $this->getPlacement(); $separator = $this->getSeparator(); switch ($placement) { case 'PREPEND': return $output . $separator . $content; case 'APPEND': default: return $content . $separator . $output; } } }

この例では、デコレータ名の最後の部分である 'Errors' が Zend_Form_Decorator_Errors と同じなので、このデコレータの かわりに レンダリングに用いられます。 つまり、特にデコレータを変更しなくても出力が変わるということです 既存のデコレータとあわせた名前のデコレータを作成すれば、 要素のデコレータを変更しなくても出力を変更することができます。

個々のデコレータのレンダリング

デコレータは特定の要素のメタデータやフォームを対象にしてデコレートすることが可能なので、 個別のデコレータをレンダリングすることができると便利です。 幸いにも、各フォーム形式 (フォーム、サブフォーム、表示グループ、要素) のメソッドをオーバーロードすることでこれが可能となっています。

そのためには render[DecoratorName]() をコールします。 ここで、"[DecoratorName]" の部分はデコレータの "短い名前" となります。オプションで、デコレートしたいコンテンツを渡すこともできます。 たとえば次のようになります。

// 要素ラベルデコレータのみをレンダリングします
echo $element->renderLabel();

// 表示グループ fieldset とそのコンテンツをレンダリングします
echo $group->renderFieldset('fieldset content');

// form HTML タグとそのコンテンツをレンダリングします
echo $form->renderHtmlTag('wrap this content');

デコレータが存在しない場合は、例外が発生します。

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