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 CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

CakePHP3でcomposerを使ってパッケージ（ライブラリ、プラグイン）をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。

: CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説

CakePHP4で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定しそれを読み込み判別する。

: CakePHP3、CakePHP4のdatetime型カラムの日時の扱い。秒まで表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

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

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

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

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

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

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

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

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。

: CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法

CakePHP3で検索をするプラグイン「friendsofcake/search」の検索条件のカスタマイズ方法の解説。検索項目を増やしたり、以上、以下での検索や、チェックボックスによる検索の方法などを解説。