CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
2024/09/08
CakePHP4のController内でViewテンプレート、レイアウトの指定はrenderを使用する
CakePHP4では、Controller内で Viewテンプレートや、レイアウトファイルをデフォルト以外のものに変更したいときは下記のように記述します。
$this->render(string $view, string $layout);
上記を記述することで、Viewのテンプレート、および、レイアウトを指定する事ができます。
また、テンプレート、レイアウトを使用しない場合は、下記の記述をします。
// テンプレートファイルを使用しない場合 $this->autoRender = false; // レイアウトファイルを使用しない場合 $this->layout = false;
CakePHP4でrenderに Viewを指定する具体的な記述方法の解説
具体的に、Controller内で Viewテンプレートや、レイアウトファイルをデフォルト以外のものに変更したいときの記述方法を解説します。
$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」と、テンプレート名を指定します。
「$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」に「/」から始まるパスを記述すると「/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"));
「render()」関数に限った話ではありませんし、CakePHP3のころも同じであったと思いますが、「render()」で指定したテンプレート内で使用する変数は、「render()」を記述するより前に「$this->set()」で指定しておく必要があります。
順番が逆だと、Viewテンプレートでは変数を扱うことができませんので、「変数がないよ!」というエラーが発生します。
単純なことなだけにエラーが発生したときになかなか気づけない不具合とも言えます。
テンプレート、レイアウトを使用しない場合は autoRender、layoutに falseを指定する
前項までは、テンプレートファイル、レイアウトファイルを指定して使用する方法の解説でしたが、テンプレートファイル、レイアウトファイルを使用しない場合の設定方法を解説します。
// テンプレートファイルを使用しない場合 $this->autoRender = false; // レイアウトファイルを使用しない場合 $this->layout = false;
記事の最初に書いたものと同じですが、大きなポイントは CakePHP3のころは利用できた下記の記述方法が使えなくなっている、という点です。
// テンプレート、レイアウトを無効にする方法 $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
CakePHP4の関連記事
CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説
CakePHP4、CakePHP5の「warning: DebugKit is disabling...」の対処方法
MySQL+CakePHPのdate型、datetime型項目は「2999-12-31」までしか扱えない
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要
CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法
CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
CakePHP4から外部のデータベースにアクセスする方法解説
CakePHP4の数値項目は「like %10%」の部分一致検索(find select)はできない
その他の「CakePHP4」に関する記事一覧
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説
CakePHPのログ出力方法の解説。app.phpにログ設定をし、スコープやレベルを指定してログ出力を振り分ける方法、CakePHP4で配列出力にはvar_exportが必要なことなどを解説。
-
-
CakePHP 2.3 ID以外のカラムでアソシエーション(連携)をさせる場合
ID以外のカラムでアソシエーション(連携)させるための考え方とサンプルソースを用いての説明を行っています。
-
-
CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説
CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート(エレメント)を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。
-
-
CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力
CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。
-
-
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。
-
-
CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法
CakePHP4系、5系のログイン認証の可否のチェック、および、ログインユーザの情報を取得する方法のまとめ。複数の方法があるが手続きが微妙に異なるためまとめてみた。
-
-
CakePHP3のインストールでURL rewriting……のエラーが!その解決方法解説
CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。
-
-
CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法
CakePHP3に付属しているデバッグのためのツール、デバッグキットを強制的に有効化、無効化する方法を解説。初期設定では開発環境としてありそうなドメインの場合のみ有効になるように設定されている。
-
-
CakePHP4系、CakePHP5系のexists()でカラムを指定して値の有無をチェックする方法解説
CakePHP4、5で指定したカラムに特定の値に該当のレコードの有無をチェックするにはexists()を使う。単純にカラムを指定する方法から複数条件をand、orで探すこともできる。
-
-
CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法
CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。