CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

2022/07/14 2023/12/28

公開側と管理側でレイアウトファイルを切り替える方法を解説

　
この記事では、
　公開しない CMSの管理側の画面のテンプレートは「default.php」
　一般公開するページのテンプレートファイルは「default_public.php」
といった感じで、公開画面側と管理画面側のデザインテンプレートを分ける方法を解説します。
　
　

CakePHP4のデフォルトのレイアウトファイルは「default.php」

　
CakePHP4のデザインテンプレートを管理しているレイアウトファイル（デザインテンプレートファイル）は下記になります。
　/templates/layout/default.php
　
この「default.php」ファイルには「html」「head」「body」タグが記述されています。
また、「$this->fetch('content')」の部分には、各 controller、actionに該当する HTMLが編集されて、ページ全体が表示される、という処理になっています。
　
　
ページのデザインを変更する場合は、「default.php」をページのレイアウトファイルとして変更を行い、あわせて、各 actionごとのテンプレートファイルを変更することになります。
　
　
ですが、「default.php」を変更すると、公開側の画面も、管理側の画面もデザインも変わってしまいます。
　
そのため、この記事では、公開側の画面と公開側の画面のデザインプレートをそれぞれ設定する方法を解説します。
　
　

「/src/View/AppView.php」に「setLayout()」で指定

　
編集対象のファイルは以下になります。
　/src/View/AppView.php
　
デフォルトの「initialize()」には何も記述されていませんので、下記の内容をまるっと追加する感じになります。
　

    public function initialize(): void
    {
      parent::initialize();

      // レイアウトとして読み込むファイルを指定する
      $this->setLayout('default_public');

      // デフォルトのデザインテンプレートを使う処理を指定（管理側の画面を指定）
      $controllerArray = ["Topics","Users"];
      $actionArray = ["index","add","edit","view"]
      if (in_array($this->request->getParam("controller"), $controllerArray)) {
        if ( in_array($this->request->getParam("action"), $actionArray) ) {
          $this->setLayout('default');
        }
      }
    }

public function initialize(): void

{

parent::initialize();

// レイアウトとして読み込むファイルを指定する

$this->setLayout('default_public');

// デフォルトのデザインテンプレートを使う処理を指定（管理側の画面を指定）

$controllerArray = ["Topics","Users"];

$actionArray = ["index","add","edit","view"]

if (in_array($this->request->getParam("controller"), $controllerArray)) {

if ( in_array($this->request->getParam("action"), $actionArray) ) {

$this->setLayout('default');

}

　
　
まず初めに
6行目で公開側のレイアウトファイルを指定します。
　
指定した「default_public」は下記のファイルになります。
　/templates/layout/default_public.php
　
このままでは、公開側も管理側も「default_public.php」に切り替わってしまいますので、13行目の処理で「default」を指定しなおします。
　
その際、「default.php」を使用する条件として、11行目で controllerを指定、12行目で actionを指定しています。
　
　
上記のサンプルでは、controllerと actionを条件としてレイアウトファイルを切り替える処理にしていますが、if文の分岐に「ログインしている／していない」を条件に加えたり、「ログインしているユーザの権限」を条件に加えたりすることで、多様な条件でデザインを切り替えることも可能になります。
　
いろいろと試してみてください。
　
　

「setLayout()」の使い方は CakePHP3でも同様

　
ちなみに、この記事は CakePHP4を対象とした記事として書いていますが、CakePHP3でも同様の記述で、同様の処理を行うことができます。
　
　/src/View/AppView.php
上記ファイルがある場所は CakePHP4でも CakePHP3でも同じです。
　
　/templates/layout/default.php
上記に関しては、ファイルが設置されているフォルダは同じ場所ですが、CakePHP3では「default.php」の拡張子が「.ctp」となっている点が異なるくらいかと思います。
　
　

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

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

Message コメントをキャンセル

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

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法

CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説

CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。