エス技研

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のバージョンを指定してインストールする詳細な手順を解説」を参照してください。)
 
 
ここでは、その「/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の関連記事

CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因
CakePHP4のフラッシュメッセージの表示場所、デザインを変更する方法を解説
CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法
国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法
CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説
CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説
CakePHP4のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()
CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
 
その他の「CakePHP4」に関する記事一覧
 
 

 - CakePHP 3.x 4.x

GoogleAdwords

GoogleAdwords

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

Message

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

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

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

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

  関連記事

CakePHP 2.3 ID以外のカラムでアソシエーション(連携)をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション(連携)させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

CakePHP 2.3でファイルをアップロード・その2 ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説
CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説

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

CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その2
CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その2

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法(webrootとpagesとを活用する方法)を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。

CakePHP 2.3 Search Pluginで検索処理 その4前方一致検索、後方一致検索、不等号による検索、between句による範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

CakePHP3ログファイルの出力方法・$this->log()の解説
CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法
国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

CakePHP4で定数に変数を埋め込み、翻訳機能「__()」で変数に値を入れる方法を紹介。定型の文章の一部だけを置換したい場合に利用すると便利。

CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定
CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。