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 コメントをキャンセル

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

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP3、CakePHP4のdatetime型カラムの日時の扱い。秒まで表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

: CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション（入力チェック）の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

: CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法

CakePHPのバージョンの調べ方2点を紹介。CakePHP3～CakePHP5は共通だが CakePHP2はフォルダ構成が異なるためコマンドのパスもオプションも異なる。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。