エス技研

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


CakePHP4で定数の設定と呼び出し方法の解説(defineとConfigure)

      2023/12/28

CakePHP4で定数の設定と呼び出し(defineとConfigure)

 
CakePHP4でサイトの構築をする際に、プログラム全体で使用する定数を設定し、それを呼び出す方法について解説します。
 
CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説」では、CakePHP3の時の設定方法として記事を書いていますが、CakePHP4では少し変更されていますので、改めて記事を書きました。
 
 
小規模なサイトであれば、定数を「bootstrap.php」に書いていく方法があります。
ファイルを分ける必要もないため、シンプルな方法です。
その方法が「bootstrap.phpに定数を設定する方法」です。
 
ですが、サイトの規模が大きくなると定数も多くなっていき、「bootstrap.php」が肥大化しますので、定数を別のファイルに分けて設定する方法もあります。
その方法が「定数を別ファイルに設定する方法」です。
 
 
 

bootstrap.phpに定数を設定する方法

 
最初は「bootstrap.php」に定数を設定(定義)する方法を解説します。
 
 

「/app/Config/bootstrap.php」に定数を設定

 
「/app/Config/bootstrap.php」に定数を設定します。
記述する場所は「bootstrap.php」のどこでも問題ありませんが、分かりやすくファイルの一番最後に追記するといいでしょう。
 

 
定数の定義は、PHPの標準関数である「define()」をそのまま利用することができます。
PHP v7以降では、「define()」関数で配列も指定することができるようになりました。
 
また、CakePHP4の関数である「Configure」を利用することもできます。
引数の 1つ目が「定数名」になり、2つ目がその定数に入れる値になります。
 
2つ目の引数には、文字列のほか、配列、連想配列を指定することもできます。
 
 
また、「Configure」では、下記の様に複数をまとめて設定することもできます。

 
 

設定した変数、定数を読み込む方法

 
「define()」関数で指定した定数は、コントローラー内でもテンプレート内でも定数名を書くだけで定数として使用することができます。簡単です。
(「define()」で定義した定数は、シングルクォートなどで囲みません。)
 

 
 
対して、「Configure::write()」で指定した変数は、「Configure::read()」を使ってコントローラー内で呼び出します。
 

 
上記のサンプルは、「initialize()」内で呼び出していますので、記述しているコントローラー全体で使用することができます。
特定のアクション内に記述し、そのアクション内だけで使用する方法もあります。
 
11行目のように「set()」メソッドを使ことでテンプレートで利用することもできるようになります。
 
 
上記の例では、「$array2 = Configure::read("array2");」のように配列全体を取得していますが、下記のように値ごとに取得することも可能です。
 

 
連想配列から値を取得する方法ですので、下記のような記述も可能ではあります。

 
 
また、テンプレートファイルで直接呼び出しをする場合は、下記のように「use Cake\Core\Configure;」を記述することで可能になります。
 

 
 
 

定数を別ファイルに設定する方法

 
定数の定義を「bootstrap.php」ファイルではなく、別ファイルに記述する方法を解説します。
CakePHP3から CakePHP4になって記述方法が変更になっていますので注意してください。
 
 

「/app/Config/const.php」ファイルを作成し定数を設定

 
「/app/Config/」フォルダの中に「const.php」ファイルを新規作成します。
(ここでのファイル名は「const.php」にしていますが、ファイル名の決まりはありませんので好みのファイル名を付けてください。)
 
定数は以下のように指定します。
 

 
「define()」関数で指定する場合は、「bootstrap.php」に記述するときと違いはありません。
 
「Configure」で指定する場合は、「return」の引数として配列で指定します。
そのため、定数の指定行は配列の値となりますので、それぞれの行の終わりは「;」ではなく「,」で区切ります。
 
 

 
ちなみに、定数を「const.php」ファイルのように別ファイルで管理する場合、「return [];」は必須となります。
そのため、配列の中は空であっても記述しておく必要があります。
 
return [];」の記述がない場合は「Config file "const.php" did not return an array」というエラーが表示されます。
 
 
定数を「const.php」ファイルに記述する際の記述方法が CakePHP3のころと異なっています。
詳しくは「CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説」に記載している内容と比べてもらえるとわかりますが、CakePHP3のソースをコピペしてもエラーが発生しますので、ご注意ください。
 
また、CakePHP3のころには必要だった「use Cake\Core\Configure;」の記述は必要なくなっています。(記述していても問題はありませんが。)
 
 

「/app/Config/bootstrap.php」に定数ファイルを読み込む設定

 
続いて、設定した「const.php」ファイルを読み込む設定を「/app/Config/bootstrap.php」に記述します。
 
記述する場所は分かりやすく「bootstrap.php」ファイルの一番最後などに記述しても OKですが、「bootstrap.php」の 81行目辺りから始まる、他のファイルもロードしている処理に追記する方がより良いでしょう。(下記 5行目、6行目を追加しています。)
 

 
 
「/app/Config/bootstrap.php」には、デフォルトで「use Cake\Core\Configure;」は記載されていますので、追記する必要はありませんが、もし、ない場合は追記をします。
 
 

設定した定数を読み込む方法

 
設定した定数を読み込む方法は、先の「bootstrap.phpに定数を設定する方法」と同じですので、ほぼコピペになりますが以下のようになります。
 

 
 
より詳しく確認したい方は下記のオフィシャルサイトをご確認ください。
 
CakePHP4 オフィシャルサイト 環境設定
https://book.cakephp.org/4/ja/development/configuration.html#environment-variables
 
 

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.

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

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

  関連記事

CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法
CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。

CakePHP 2.3でOn Duplicate Key構文を実装

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

CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応
CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応

CakePHP3で検索を担うプラグイン「friendsofcake/search」の紹介。基本的な設置方法の紹介のほか、処理の記述方法のバリエーション、エラーの解説など。CakeDC/searchより導入は簡単!

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

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

CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説
CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可
CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる!

CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。

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

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

CakePHP3のバージョンを指定してインストールする詳細な手順を解説
CakePHP3、CakePHP4のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。