CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

2024/08/10 2024/09/08

CakePHP4のController内でViewテンプレート、レイアウトの指定はrenderを使用する

　
CakePHP4では、Controller内で Viewテンプレートや、レイアウトファイルをデフォルト以外のものに変更したいときは下記のように記述します。
　

$this->render(string $view, string $layout);

1	$this->render(string $view, string $layout);

　
上記を記述することで、Viewのテンプレート、および、レイアウトを指定する事ができます。
　
　
また、テンプレート、レイアウトを使用しない場合は、下記の記述をします。
　

// テンプレートファイルを使用しない場合
$this->autoRender = false;
// レイアウトファイルを使用しない場合
$this->layout = false;

// テンプレートファイルを使用しない場合

$this->autoRender = false;

// レイアウトファイルを使用しない場合

$this->layout = false;

CakePHP4でrenderに Viewを指定する具体的な記述方法の解説

　
具体的に、Controller内で Viewテンプレートや、レイアウトファイルをデフォルト以外のものに変更したいときの記述方法を解説します。
　

$view = "/element/sampleView";
$layout = "sampleLayout";

$this->render($view, $layout);

$view = "/element/sampleView";

$layout = "sampleLayout";

$this->render($view, $layout);

　
「$view」に編集するテンプレートのファイル名ですが、下記のルールがあります。
・拡張子の「.php」は記述しない
・標準フォルダ内にある場合はファイル名のみで OK
・「/」から始めると「/templates」からの相対パスになる
　
　

デフォルト設定で処理される Viewについて

　
そのため、例えば、下記の Controller、Actionで処理をしているとします。
　Controller名「Samples」
　Action名「getData」
　
この場合、「render」でテンプレートを指定しないデフォルトの状態では下記のファイルをテンプレートとして使用します。
　/templates/Samples/get_data.php
　
ここで注意が必要な点は、Action名は「getData」のようにローワーキャメルケースで記述しますが、テンプレートのファイル名は「get_data.php」のようにスネークケースで記述することになります。
　
これを間違えると下記の「テンプレートファイルがないよ」というエラーが発生します。
Missing Template Cake\View\Exception\MissingTemplateException Error The view for SamplesController::getData() was not found.
　
　

デフォルトのフォルダ内にある Viewを renderに指定をする方法

　
今度は、デフォルトのフォルダ内にある「get_image.php」というテンプレートファイルを使用したい場合の対応です。
　
下記のファイルを使用します。
　/templates/Samples/get_image.php
　
この場合の renderに指定する記述方法は以下となります。
　

$view = "get_image";

$this->render($view);

$view = "get_image";

$this->render($view);

　
上記のように、「$view」に「get_image」と、テンプレート名を指定します。
　
「$view = "getImage";」のようにローワーキャメルケースで記述しても動作はしますが、公式 Cookbookでもスネークケースで記述してありますので、規約上はスネークケースで記述する方が正しいようです。
　
ちなみに、「$view = "getImage";」と記述しても、テンプレートファイルは「get_image.php」である必要があり、「getImage.php」では読み込まれません。
　
　

フォルダのパスも含めて Viewを指定をする方法

　
最後は、フォルダのパスも含めて Viewのファイル名を指定する方法です。
　
下記のファイルを使用します。
　/templates/element/get_record.php
　
この場合の renderに指定する記述方法は以下となります。
　

$view = "/element/get_record";

$this->render($view);

$view = "/element/get_record";

$this->render($view);

　
上記のように、「$view」に「/」から始まるパスを記述すると「/templates」からの相対パスとして扱われます。
　
　
実ファイルを「/templates/element/getRecord.php」とした場合、「$view = "getRecord";」とすることで、テンプレートファイルを読み込むことはできます。
ですが、公式 Cookbookではスネークケースで記述してありますので、規約上はスネークケースで記述する方が正しいようです。
　
ファイル名がキャメルケースの「getRecord.php」である場合は renderにも「getRecord」と記述する必要があり、スネークケースの「get_record.php」である場合は renderにも「get_record」と記述する必要があるようです。
キャメルケース、スネークケースが混在している場合はエラーになります。
　
　
ちなみに、規約からは外れるようですが、
　/templates/Samples/getData.php
上記のように、標準フォルダ内にキャメルケースで記述したファイルをテンプレートとして使用する場合は、
　$view = "/Samples/getData";
のようにパス付でファイル名を指定する事で使用することは可能です。
　
　

「render()」を使用する際の注意点・renderは最後に書く理由

　
「render()」を使用する場合の注意点は
「$this->render(string $view, string $layout);」は可能な限り Controller内の最後に書くことが必要です。
　
　
理由は単純です。
「$this->render(string $view, string $layout);」の後に記述された「$this->set()」の変数は受け取ることができないためです。
　
　

// 問題は発生しない順番
$this->set(compact("sampleData01","sampleData02"));
$this->render("sampleView");

// 問題が発生する順番（変数を受け取れない）
$this->render("sampleView");
$this->set(compact("sampleData01","sampleData02"));

// 問題は発生しない順番

$this->set(compact("sampleData01","sampleData02"));

$this->render("sampleView");

// 問題が発生する順番（変数を受け取れない）

$this->render("sampleView");

$this->set(compact("sampleData01","sampleData02"));

　
　
「render()」関数に限った話ではありませんし、CakePHP3のころも同じであったと思いますが、「render()」で指定したテンプレート内で使用する変数は、「render()」を記述するより前に「$this->set()」で指定しておく必要があります。
　
順番が逆だと、Viewテンプレートでは変数を扱うことができませんので、「変数がないよ！」というエラーが発生します。
　
　
単純なことなだけにエラーが発生したときになかなか気づけない不具合とも言えます。
　
　

テンプレート、レイアウトを使用しない場合は autoRender、layoutに falseを指定する

　
前項までは、テンプレートファイル、レイアウトファイルを指定して使用する方法の解説でしたが、テンプレートファイル、レイアウトファイルを使用しない場合の設定方法を解説します。
　

// テンプレートファイルを使用しない場合
$this->autoRender = false;
// レイアウトファイルを使用しない場合
$this->layout = false;

// テンプレートファイルを使用しない場合

$this->autoRender = false;

// レイアウトファイルを使用しない場合

$this->layout = false;

　
記事の最初に書いたものと同じですが、大きなポイントは CakePHP3のころは利用できた下記の記述方法が使えなくなっている、という点です。
　

// テンプレート、レイアウトを無効にする方法
$this->render(false,false);
// テンプレートだけ無効にする方法
$this->render(false,null);
// レイアウトだけ無効にする方法
$this->render(null,false);

// テンプレート、レイアウトを無効にする方法

$this->render(false,false);

// テンプレートだけ無効にする方法

$this->render(false,null);

// レイアウトだけ無効にする方法

$this->render(null,false);

　
そのため、「$this->autoRender = false;」「$this->layout = false;」をぞれぞれ指定する必要があるようです。
　
　
参考サイト
https://book.cakephp.org/4/ja/controllers.html
https://book.cakephp.org/4/ja/views.html
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

: CakePHP 2.3で saveの便利な使い方・サンプルソース付き

CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。

: CakePHP 2.x系　Viewでのコメントの記述方法など

CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: CakePHP4、CakePHP5のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP4の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。