symfonyにてテンプレートコードの共通化や再利用する方法はいくつかある。今回はそのあたりをまとめてみる。

方法としては、

  1. インクルード(include)
  2. パーシャル(partial)
  3. コンポーネント(component)
  4. コンポーネントスロット(component_slot)
  5. スロット(slot)

これを一つ一つ見てみる。

インクルード(include)

共通化されたコードが静的なHTMLだったり、actionなどに依存しないPHPコードくらいなら、include()がよさそう。

共通化したいフッタファイルを、アプリケーション共通のtemplateディレクトリに配置した場合はこんな感じで呼び出す。

PLAIN TEXT
PHP:
  1. <?php include(sfConfig::get('sf_app_template_dir').'/footer.php')) ?>

用途としては、ヘッダ、フッターファイル、静的なメニューなど。

パーシャル(partial)

上記のインクルードに、actionからの引数を渡せるようなイメージ。

呼び出し側は下記のように、userオブジェクトをsidebarパーシャルに渡している。

PLAIN TEXT
PHP:
  1. <?php include_partial('global/sidebar', array('site' => $site)) ?>

呼び出される側は_(アンダーバー)から始まるファイル名をつける。上記の呼び出しの場合は、
app/application/template/_sidebar.phpというファイル名になる。

PLAIN TEXT
PHP:
  1. 現在のパス：<?php echo $site->getName() ?>

用途としては、サイドバーにカートの内容を表示したり、動的な部分を部品化するイメージ。

コンポーネント(component)

上記のパーシャルよりもさらに独立した動的なロジックが必要な場合。本来のactionとかけ離れた処理をサイドバーなどに表示させるときなどは、サイドバー用の処理とactionの処理を分け、サイドバー用の処理をコンポーネントでまとめるといったことができる。

サイドバーにて、ニュースの一覧記事を取得するような処理を想定した、呼び出し側は下記のようになる。

PLAIN TEXT
PHP:
  1. <?php include_component('news', 'headlines', array('user' => $user)) ?>

呼び出される側のロジックは、actionクラスをcomponentクラスとして名前を変更すれば、普段のアクションクラスのようなロジックを書ける。
apps/application/module/news/action/components.class.php

PLAIN TEXT
PHP:
  1. <?php
  2.  
  3. class newsComponents extends sfComponents
  4. {
  5.   public function executeHeadlines()
  6.   {
  7.     $c = new Criteria();
  8.     $c->addDescendingOrderByColumn(NewsPeer::PUBLISHED_AT);
  9.     $c->setLimit(5);
  10.     $this->news = NewsPeer::doSelect($c);
  11.   }
  12. }
  13.  
  14. ?>

上記の例の場合、テンプレートは下記の位置に配置する。
apps/application/module/news/template/_headlines.php

用途としては、上記のようなサイドバーにてニュースの一覧を表示したりするとき。

コンポーネントスロット(component_slot)

上記のコンポーネントにさらに、呼び出しの度に変化するような場合はコンポーネントスロットを利用する。ここが少しややこしい気がするが、呼び出し側は同じでも、view.ymlにより呼び出すロジックを変更できるようなイメージ。

呼び出し側は、layout.phpなどで下記のようになる。

PLAIN TEXT
PHP:
  1. <?php include_component_slot('sidebar') ?>

app/application/config/view.ymlにはデフォルトのコンポーネントを登録しておく。

PLAIN TEXT
CODE:
  1. default:
  2.   components:
  3.     sidebar:  [menu, default]

そして、モジュールによって呼び出すロジックが変わる場合は、
app/application/module/foo/view.ymlなどのmodule側のview.ymlを下記のようにしておく。

PLAIN TEXT
CODE:
  1. default:
  2.   components:
  3.     sidebar:  [menu, user]

こうすることで、componentのdefaultを呼ぶか、userを呼ぶかなどモジュール、アクションなどにより変更できる。

スロット(slot)

いままでのものとはちょっと違うが、1回のレスポンスの中で部品化したい場合に2度同じテンプレートロジックを利用したいときなどに利用できる。

PLAIN TEXT
PHP:
  1. <?php slot('hoge') ?>
  2. hoge
  3. <?php end_slot() ?>
  4.  
  5. <?php include_slot('hoge') ?>

slotで囲んだhogeがもう一度、下のinclude_slotで呼びだせます。

少しややこしいですが、こうしたテンプレートの部品化は設計にも影響与えてくる部分なのでしっかり見につけておきたい。

しかしこのややこしさ、どうにかならんものか。。。

symfony View:テンプレート、レイアウト、パーシャルとコンポーネント

関連する記事

blogranking←ぽちっとな

＜＜
＞＞