CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

2019/08/04 2019/08/05

Apacheに環境変数を設定し本番環境と開発環境を振り分ける処理

定数の設定ファイルを本番環境用と開発環境用とで分ける

　
「CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説」で、定数、変数を別ファイルで管理する方法を解説しました。
　
PHP7以降は、配列も「define()」で定数として指定できるようになりましたので、配列も含めて定数として保持しておきたい情報を管理することが楽になりました。
　
　
今回は、その定数などを設定しておく設定ファイルを、開発環境と本番環境とで自動的に切り替える方法を解説します。
　
　
例えば、下記のような URLなどの開発環境と本番環境で値が違う場合を想定しています。
　

// 開発環境
define("SITE_URL","http://localhost");

// 本番環境
define("SITE_URL","http://example.com");

// 開発環境

define("SITE_URL","http://localhost");

// 本番環境

define("SITE_URL","http://example.com");

　
本番環境では本番環境のものを、開発環境では開発環境のものが取得されるようにすることで、本番環境にアップする際に設定情報を変更することなく、そのままアップすればいい、という仕組みを構築することができるようになります。
　
　
対応の詳細は次項以降で解説しますが、開発環境の方に「環境変数」を設定しておき、それが取得できた場合は開発環境と判定して開発環境の定数ファイルを読み込む、という仕組みです。
（「環境変数」が取得できない場合は、本番環境と判定します。）
　
　

定数ファイルを作成

　
まずは、「CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説」の記事に沿って設定ファイルを作成します。
　
開発環境用
/config/const_develop.php
　
本番環境用
/config/const_production.php
　
　
開発環境用の「const_develop.php」には下記を設定します。
　

<?php
use Cake\Core\Configure;
return [
    // サイトの URL
    define("SITE_URL", "http://localhost"),
];

<?php

use Cake\Core\Configure;

return [

// サイトの URL

define("SITE_URL", "http://localhost"),

];

　
　
本番環境用の「const_production.php」には下記を設定します。
　

<?php
use Cake\Core\Configure;
return [
    // サイトの URL
    define("SITE_URL", "http://example.com"),
];

<?php

use Cake\Core\Configure;

return [

// サイトの URL

define("SITE_URL", "http://example.com"),

];

定数ファイルを取得する bootstrap.phpに分岐処理を記述

try {
    Configure::config('default', new PhpConfig());
    Configure::load('app', 'default', false);

    // 定数ファイルを読み込み
    if (isset($_SERVER["CAKE_ENV"]) && $_SERVER["CAKE_ENV"] == "develop"){
        Configure::load("const_develop");
    } else {
        Configure::load("const_production");
    }

} catch (\Exception $e) {
    exit($e->getMessage() . "\n");
}

try {

Configure::config('default', new PhpConfig());

Configure::load('app', 'default', false);

// 定数ファイルを読み込み

if (isset($_SERVER["CAKE_ENV"]) && $_SERVER["CAKE_ENV"] == "develop"){

Configure::load("const_develop");

} else {

Configure::load("const_production");

}

} catch (\Exception $e) {

exit($e->getMessage() . "\n");

}

　
上記の 6行目のように環境変数によって処理を振り分ける処理を記述します。
　
　
環境変数は、「getenv("CAKE_ENV")」でも取得することができます。
CakePHP3の場合は、「env("CAKE_ENV")」でも取得することができます。
　
また、私の環境ではうまく取ることができませんでしたが、「$_ENV["CAKE_ENV"]」でも取得できるようです。
　
　

環境変数をApacheの設定ファイル「httpd.conf」に設定

　
最後に、振り分け処理で利用する「環境変数」を設定します。
環境変数は、開発環境にのみ指定します。
（ある程度自由に設定情報を変更することができる開発環境にのみ設定する、というところもポイントです。）
　
　
設定場所は、Apacheの設定ファイル「/etc/httpd/conf/httpd.conf」です。
（「httpd.conf」のパスは CentOSを想定しています）。
　
「httpd.conf」ファイルを開いて、ファイルの一番最後などに書きの記述を追加します。
　

SetEnv CAKE_ENV develop

1	SetEnv CAKE_ENV develop

　
「CAKE_ENV」が環境変数の変数名で、「develop」がその値になります。
複数設定することもできます。
　
設定後は Apacheを再起動して環境変数を反映させます。
　
　
また、環境変数が正しく反映されたことの確認には、「phpinfo()」を実行する方法があります。正しく設定されている場合は画面に表示されます。
　
　
これで、設定した環境変数が取得できれば、開発環境の設定ファイルが読み込まれるようになります。
　
　

Shellを実行する場合はコマンド内に環境変数を指定する

　
CakePHP3の Shellでバッチ処理を作成して、コマンドラインから Shellを起動して実行する場合は、下記のようにコマンド内に環境変数を指定します。
　

// コマンドラインからシェルを実行する
$ bin/cake SampleTests getList

// コマンドの前に環境変数を指定する
$ CAKE_ENV=develop bin/cake SampleTests getList

// コマンドラインからシェルを実行する

$ bin/cake SampleTests getList

// コマンドの前に環境変数を指定する

$ CAKE_ENV=develop bin/cake SampleTests getList

　
Shellを実行する場合、Apacheを経由せずにプログラムが実行されるため、Apacheの設定ファイル「/etc/httpd/conf/httpd.conf」に環境変数を記述していてもそれは読み込まれません。
　
そのため、実行するコマンドの中に環境変数を直接記述しておく必要があるのです。
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: CakePHP3で「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」などのエラーが出たときの確認するポイント

CakePHP3の開発で発生する「SQLSTATE[23000]: Integrity constraint violation」「SQLSTATE[42S22]: Column not found」のエラーには特有の原因もあるため、その説明と対処方法の解説。

: CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。

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

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

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

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

: CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

PHPでサーバ情報、環境情報を取得する際は「$_SERVER」を利用するが、似たような情報をCakePHPの関数で取得する際は「getUri()」を使用する。取得出来る値は一致するものもあるが、違うものもあり便利な使い方もある。