CakePHP の小ネタ｜加藤正人｜デベロッパーズブログ

DEVELOPERS BLOGデベロッパーズブログ

HOME >
加藤正人 >
タイトル

2014/07/26

CakePHP の小ネタ

先日お客様サイトでページ体裁を変更する仕事があったのだが、実サイトでお客様に確認してもらう必要があった。ただし、現状のページは一般の人にはそのまま表示され続けなければならないという制限があった。

このような場合、これまでは当該ページを管轄するコントローラにテスト用ページのアクションとテンプレートを追加していたのだが、承認が下りた後追加したアクションの削除が面倒だ。

ということで、包括的にテストページを試すためのネタを考えてみた。

URL パラメータで本来のページURLに情報を付加
付加したパラメータに従ってテスト用テンプレートを選択
パラメータがない場合は本来のテンプレートを選択
パラメータに合致するテンプレートが実在しない場合も本来のテンプレートを選択

このようにしておけば、違和感なくテストページを見てもらえると思う。たとえば、http://www.hogehoge.com/user/blog/id:1 のような URL を持つページに対し、http://www.hogehoge.com/user/blog/id:1?test=1 のようにすると本来のテンプレートではなく、"{本来のテンプレート}_test_1" を使用するような方法だ。同様に ?master=2 のようにすると、レイアウトも "{本来のレイアウト}_test_2" を使用するようにしておくと便利だ。

これを実現するには、コントローラの render() パブリックメソッドをオーバーライドするのが早い。

class FrontpageController extends AppController
{
	// …【中略】…

	// CakePHP 2.x 用 render() メソッドのオーバーライド
	public function render($view=NULL, $layout=NULL)
	{
		if ( is_null($view) )
		{
			$view = $this->request->params['action'];	// 既定値のビュー
		}
		if ( strlen($tmp=@$this->request->query['test']) > 0 )
		{
			$tmp_view = "{$view}_test_{$tmp}";	// URL に test= がパラメータとして付加されていた場合はテスト用テンプレートで表示する
			if ( file_exists(APP . 'View' . DS . $this->name . DS . $tmp_view . '.ctp') )
			{
					$view = $tmp_view;	// テスト用テンプレートが実在するならテスト用テンプレートに切り替える
			}
			else
			{
				// テスト用テンプレートが実在しないなら本来のテンプレートを使用する
				// (もし必要ならここにエラー処理を記述する)
			}
		}
		if ( is_null($layout) )
		{
			$layout = $this->layout;	// 既定値のレイアウト
		}
		if ( strlen($tmp=@$this->request->query['master']) > 0 )
		{
			$tmp_layout = "{$layout}_test_{$tmp}";
			if ( file_exists(APP . 'View' . DS . 'Layouts' . DS . $tmp_layout . '.ctp') )
			{
				$layout = $tmp_layout;	// テスト用レイアウトが実在するならテスト用レイアウトに切り替える
			}
			else
			{
				// テスト用レイアウトが実在しないなら本来のレイアウトを使用する
				// (もし必要ならここにエラー処理を記述する)
			}
		}
		parent::render($view, $layout);
	}
	// …【以下略】…
}

上記のように自コントローラで render() をオーバーライドしておく。

ただし、この方法には欠点が１つある。

この方法を採用した場合、autoRender による自動レンダリングを利用しているアクションの場合は正しく動作しないので、そのようなアクションにはアクションから離脱する箇所に $this->render(); を追加しておく必要がある。

こうしておけば、本来のビューテンプレートlと同じ場所に "{テンプレート名}_test_1"、"{テンプレート名}_test_2" というテンプレートが存在していれば、http://ホニャララ/?test=1 とか http://ホゲホゲ/?test=2 のようにしてビューを切り替えて同じサイト上で見かけの変更を簡単に確認することができる。

また、確認が終わったら不要なテンプレートを削除するだけでコントローラには手を加えなくてよい。