SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

Zend Framework入門

Zend Framework入門(12):
フォームのカスタマイズ - Zend_Form -(後編)

Zend Frameworkによる実践的なPHPアプリケーション開発 12

  • X ポスト
  • このエントリーをはてなブックマークに追加

Zend_Formのデコレータ

 今までの例で見たとおり、Zend_Formを利用してフォームを出力すると自動的にformタグやdlタグなどが付加されていました。では、これはどのような仕組みで実現されているのでしょうか? また、ここで出力されているタグをカスタマイズすることは可能なのでしょうか?

 Zend_Formでは、描画がどのように行われるかを制御する仕組みは「デコレータ」と呼ばれています。デコレータというとフォームやフォーム要素を装飾する仕組みのように聞こえますが、デコレータはそれだけでなく、そもそもどのような内容が出力されるかを含めて決める仕組みです。

 デコレータは複数登録することが可能です。これらのデコレータは順番に呼び出されて、フィルタのように前のデコレータが加工した結果を受け取って、それを加工し、次に登録されているデコレータに渡します。

フォームのデコレータ

 まず、フォーム全体がどのように描画されているかを見て行きましょう。フォームの描画はそのフォームに登録されているデコレータが順番に呼ばれることで行われます。Zend_Formが標準で利用しているデコレータはZend FrameworkのZend/Form.phpの_loadDecoratorメソッドに記述されています(リスト4)。

 addDecoratorメソッドはフォームにデコレータを追加するためのメソッドで、addDecorator($decorator, $options)の2つの引数で呼び出します。ここで$decoratorはデコレータのインスタンスないしデコレータの名前、$optionsはそのデコレータへのオプションを配列にしたものを渡します。リスト4を見てみると、標準ではFormElementsデコレータ、HtmlTagデコレータ、Formデコレータが順番に作成・登録されていることが分かります。

リスト4 Zend_Formが標準で利用しているデコレータ(Zend/Form.phpより)
$this->addDecorator('FormElements')
     ->addDecorator('HtmlTag', array('tag' => 'dl', 'class' => 'zend_form'))
     ->addDecorator('Form');
));

 これはどのように描画に反映されるのでしょうか? 前の例で取り上げたフォームについて、どのデコレータが出力のどの部分を担当しているかを示したのが図4です。頭と最後のformタグはFormデコレータ、その間にあるdlタグはHtmlTagデコレータ、そして中身はFormElementsデコレータによって出力されています。

図4 フォームがデコレータでどのように出力されているか
図4 フォームがデコレータでどのように出力されているか

フォーム要素のデコレータ

 同じように、フォーム要素もデコレータによって描画されています。標準ではリスト5にあるデコレータを利用しています。

リスト5 フォーム要素が標準で利用しているデコレータ(Zend/Form/Element.phpより)
$this->addDecorator('ViewHelper')
      ->addDecorator('Errors')
      ->addDecorator('HtmlTag', array('tag' => 'dd'))
      ->addDecorator('Label', array('tag' => 'dt'));

 このように、標準では上の4つのデコレータを利用して描画を行っています。

デコレータ関係のメソッド

 フォーム(Zend_Form)にもフォーム要素(Zend_Form_Element)にもデコレータを追加・削除・設定するためのメソッドは同じようなものが準備されています。まず最初に、これらのクラスで共通なデコレータの追加・削除・設定のためのメソッドの一覧を示します。

デコレータ関係のメソッド
メソッド名 引数名 説明
addDecorator $decorator, $options デコレータ$decoratorを追加します。$optionsはデコレータへのオプション(省略可能、どのようなデコレータがどのようなオプションを利用するかについては後にある標準で添付されているデコレータを参照して下さい)。
addDecorators $decorators 複数のデコレータを登録します。$decoratorsは配列。
setDecorators $decorators 現在登録されているデコレータを削除し、複数のデコレータを登録します。$decoratorsは配列。
getDecorator $name 登録されている名前が$nameのデコレータを返します。
getDecorators なし 登録されている全てのデコレータを返します。
removeDecorator $name 登録されている名前が$nameのデコレータを削除します。
clearDecorators なし 登録されている全てのデコレータを削除します。

 また、この他にZend_Formクラスにはそのフォームに含まれるフォーム要素のデコレータを全て変更するメソッドsetElementDecoratorsメソッドがあります。

 では、これらを利用してデコレータを変更してみましょう。標準ではフォームはdl、dt、dlタグを利用して描画されますが、これをul、liタグを利用して描画するように変更します(リスト6)。

リスト6 デコレータの変更(サンプルのIndexController.phpより)
public function decoratorAction()
{
    $form = new Zend_Form;

    $form->clearDecorators();
    $form->addDecorator('FormElements')
          ->addDecorator('HtmlTag', array('tag' => 'ul',
                         'class' => 'zend_form'))
          ->addDecorator('Form');
    $this->addElements($form);

    $form->setElementDecorators(array('ViewHelper',
                                      'Label',
                                      array('HtmlTag', array('tag' => 'li'))));
    $this->view->assign('form', $form);
    return $this->render('index');

 リスト6では、まずフォームで利用しているデコレータを削除した上で、addDecoratorメソッドで追加したデコレータではulを利用するように変更してます。更にsetElementDecoratorsで各フォーム要素について、liタグを描画するようにしています。これを描画したものは図5となります。

図5 デコレータを利用したフォーム
デコレータを利用したフォーム

次のページ
標準で添付されているデコレータ

修正履歴

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
Zend Framework入門連載記事一覧

もっと読む

この記事の著者

山田 祥寛(ヤマダ ヨシヒロ)

静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるReact実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

WINGSプロジェクト 風田 伸之(カゼタ ノブユキ)

WINGSプロジェクトについて> 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書記事多数。 RSS Twitter: @yyamada(公式)、@yyamada/wings(メンバーリスト) Facebook

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/3185 2008/11/14 14:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング