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　ID以外のカラムでアソシエーション（連携）をさせる場合

ID以外のカラムでアソシエーション（連携）させるための考え方とサンプルソースを用いての説明を行っています。

: CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。

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

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

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHPで Auto Incrementを外すと Duplicate entry ‘0’ for keyのエラーが出るかも

CakePHPでAuto Incrementの設定を変更したときに「Duplicate entry ‘0’ for key」のエラーが出た。原因はModel内で IDを編集する処理の追加を忘れていたからだった。