エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

      2023/12/28

CakePHP4で「app_local.php」「.env」を利用して定数を定義する方法

 
CakePHP4では、
 「app_local.php」ファイル
 「.env」ファイル
にて定数を定義することができるようになっています。
 
この記事では、「app_local.php」「.env」で定数を定義する方法、呼び出す方法の解説をします。
 
 
ちなみに、「app_local.php」「.env」のいずれも、Gitでの管理対象にはしない設定になっています。
 
 
また、「CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説」では、定数を定義したファイルを「環境変数」を使用して「本番環境」と「開発環境」を振り分ける方法を解説していますので、併せて参考にしてください。
 
 

「app_local.php」を利用して定数を定義する方法

 
CakePHP4では、環境ごとに異なる定数を定義する「/config/app_local.php」と言うファイルが用意されています。
 
「app_local.php」ファイルには
 デバッグモードの設定
 salt
 データベースの接続情報
 SMTPの接続情報
が記載されています。
 
これらの情報は、CakePHP3の頃には「app.php」に記述していましたが、開発環境と本番環境とで異なる情報となりますので、CakePHP4では「app.php」と分けて管理することになっています。
 
(CakePHP3、CakePHP4をインストールし、DB接続情報などの設定する方法の解説などは「CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説」を参照してください。)
 
 
ここでは、その「/config/app_local.php」ファイルに開発者が独自に設定する定数を記載して管理する方法を解説します。
 
 
定数を別ファイルに指定して管理する方法については「CakePHP4で定数の設定と呼び出し方法の解説(defineとConfigure)」に詳しく記載しています。
その内容を理解している前提で話を進めさせていただきます。
 
 

「/config/app_local.php」ファイルに定数を定義する

 
まず、「/config/app_local.php」に記載する内容です。
 

 
上記の 10行目~31行目が追加した記述になります。
 
それぞれ、定数を指定する方法、配列を指定する方法、定数を「AppLocalConst」というひとまとめの定数で指定する方法などがあります。
 
 

「/config/app_local.php」に定義した定数を呼び出す

 
続けて、「/config/app_local.php」に記述した定数を呼び出す方法です。
 
「/config/app_local.php」に記載した定数を取得する場合は「Configure::read()」を使用します。
 
下記は、定数を使用する Controllerに「initialize()」を追加してそこで呼び出す記述をしています。
 
Controller全体ではなく、特定の Actionのみで使用する場合は、Actionの中に同様の記述をしてください。
 

 
ちなみに、『配列「AppLocalTest02」内の「test01」を呼び出す』の「その2」の記述方法はむりやり感がありますが、「Configure::read("AppLocalTest02")」の部分で配列を取得していますので、こんな記述方法も可能ではあります。
 
 

「.env」を利用して定数を定義する方法

 
「/config/.env」ファイルを使用して定数を指定する方法を解説します。
 
 

「.env」ファイルの使用できるようにする

 
デフォルトの設定では「.env」の内容を読み込める様になっていませんので、「.env」ファイルを使用できるようにします。
 
/config/bootstrap.php
の 63~69行目の下記の部分のコメント処理を外します。
 

 
 

「.env」ファイルの生成する

 
続けて「.env」ファイルを生成します。
 
CakePHP4では「/config/.env」ファイルはデフォルトでは用意されていませんので、「/config/.env.example」をコピペして「.env」ファイルを作成します。
 
また、「/config/.env」ファイルの 16~21行目の設定は不要ですので、コメントにしておきます。
「.env」ファイルでコメントにする場合は、行頭に「#」を記述します。
 
 
「.env」ファイルに定数を定義する場合は、下記の様に「export」に続けて定義を記述します
 

 
ちなみに、「.env」ファイルで設定できる定数は「文字列のみ」です。
そのため、配列を指定したい場合は、擬似的な対応となります。
 
 

「/config/.env」に定義した定数を呼び出す

 
「.env」ファイルに設定した定数を呼び出す場合は「env()」関数を使用します。
「env()」関数で呼び出す方法は、Controllerでも View(テンプレートファイル内)でも同じ記述で使用できます。
 

 
また、「.env」ファイルに擬似的な配列を指定した場合は、上記のように「explode()」関数にて文字列を配列に分割して使用します。
(文字列の中に「,」がある場合は、「,」以外の区切り文字を使うといいでしょう。)
 
 
また、「.env」ファイルで定義した定数を、「env()」を使わずに定数として呼び出したい場合は、「/config/bootstrap.php」ファイルに下記の様に改めて定数として定義し直す方法があります。
 

 
また、定数を別ファイルで定義する方法については「CakePHP4で定数の設定と呼び出し方法の解説(defineとConfigure)」に記事を書いていますので参考にしてください。
 
 

CakePHP4では「app_local.php」と「.env」のどちらを使う方がいい?

 
CakePHP4で定数を管理する場合
 「/config/app_local.php」
 「.env」
のどちらで定数を定義する方がいいか?
についてですが、「/config/app_local.php」の方がいいのであろうと思います。
 
そもそも、CakePHP4のデフォルトでは「.env」は用意されていませんし(「.env.example」は用意されていますが)、必要な処理はコメントアウトされており使用できるようになっていません。
 
CakePHP4の「.env」は、CakePHP3や他のフレームワークで「.env」ファイルを使用していた方に対して、CakePHP4でも同じ様な使用感で定数を定義するためのオプションなのだと考えています。
 
また、「.env」では配列を定義することができないために使い勝手がいいとは言えず、その点も含めて、「.env」より「app_local.php」を使う方がいいのだろうと思います。
 
ただ、「.env」は「.」で始まるファイルのため、セキュリティの点でちょっとだけ有利なのかも知れません。
 
 
ちなみに、「app_local.php」と「.env」は、基本的に Gitでは管理しないファイルとなっています。
理由は、データベースの接続情報やメールサーバへの接続情報などの機密情報を記載するファイルとなるためです。
 
そのため、この記事では「app_local.php」や「.env」で定数を管理する方法を紹介してはいるものの、開発者が独自に定義する定数は「app_local.php」「.env」には記載しない方がいいのだろうと思います。
 
環境ごとで変わる定数を管理する方法としては、「CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説」に書いている「環境変数」で定数を振り分ける方法をオススメします。
 
 

CakePHP4の関連記事

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 3.x 4.x 5.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

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

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

getParam('action')で取得するアクション名は別関数に移動しても不変
getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

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

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

CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法
CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因
CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因

Bakeして自動生成した入力フォーム処理を元に少し処理を追加したら、入力エラーがあってもエラーメッセージが表示されなくなった。原因はリダイレクトの処理にあった。

CakePHP3でレコードを追加、更新(Insert、Update)する複数の方法を紹介
CakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介

CakePHP3でレコードを追加、更新(Insert、Update)する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

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

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

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

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

CakePHP 2.3 bakeの超初心者向けフォロー講座

CakePHP 2.3 bakeの超初心者向けフォロー講座