文系Webエンジニアの技術メモとたまに旅のメモ

未経験文系エンジニアとして働いてます。アウトプットとして簡単に技術メモを残していきます。たまに旅関係のも趣味で残していこうと思ってます。

【CakePHP3/定数】CakePHP3で定数ファイル作成から設定する方法!

今回は、CakePHP3での定数の使用方法を記していきます。

1.定数ファイルの作成 (const.php)

はじめに、定数ファイルの作成を行いましょう。
ファイル名は任意ですが、定数ファイルとわかるような名前にしましょう。
今回は「const.php」と命名します。

下記ディレクトリに作成をします。

/config/const.php

2.定数ファイルへの記述

今後、定数を追加する際は、「const.php」に記述をしていきましょう。
テストとして、下記定数を追加します。
※配列で表示する文字列としては少し変ですが、例です。

const.php
<?php
return [
    // 都道府県
    define('HOKKAIDO', 1), // 北海道
    define('AOMORI',   2), // 青森

    define('PREFECTURES', [
        HOKKAIDO => '北海道',
        AOMORI   => '青森',
    ]),
];

3.定数ファイルを使用するための設定

「const.php」を作成しただけでは、定数はまだ使えません。
「bootstrap.php」に「const.php」を使用可能にする記述を行います。

/config/bootstarp/php
<?php
Configure::load('const');

これで、設定は完了です。

4.定数の使用できるか確認

上記で設定は完了しました。
最後に実際に使用できるか確認して見ましょう。

任意のControllerのfunction内でconst.phpに定義した定数を使って見ましょう。

UsersController.php
<?php
public function index()
{
    debug(HOKKAIDO);
    debug(PREFECTURES(AOMORI));
}

上記ControllerアクションのURLにアクセスし、下記の通り表示されていれば完了です。

/src/Controller/UsersController.php (line xx)
(int) 1
/src/Controller/UsersController.php (line xx)
'青森'