Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法

2024/06/22 2024/06/23

Windows上のXAMPP環境のコマンドラインから CakePHPのコマンド実行する際に環境変数を指定する方法

　
今回は「CakePHP4でコマンドプログラムを作成する」の全 4回のうちの最終回で、「XAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法」について解説します。
　

環境変数は Linuxと Windowsとで指定方法が異なる

　
CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説
上記の記事で、CakePHPの環境変数を設定して本番環境と開発環境を振り分ける解説をしましたが、その際、コマンド（シェル）を実行する際に環境変数を指定して実行する方法も解説しました。
　
ですが、上記の記事で解説していた方法は、Linux環境では有効ですが、Windows上に構築している XAMPP環境では実行できないことを確認しましたので、改めて、Linux環境と Windows環境とで実行できる方法を解説します。
　
　

Linuxと Windowsでコマンドを実行する方法

　
まずおさらいから。
　
Linux環境でコマンドラインからコマンド（シェル）を実行する場合は、ルートフォルダから下記を実行します。
（「SampleTests」と言うコマンド（シェル）に「getList」と言う引数（パラメータ）を付けて実行するコマンドです。）
　

// コマンドラインからコマンドを実行する場合
$ bin/cake SampleTests getList

1 2	// コマンドラインからコマンドを実行する場合 $ bin/cake SampleTests getList

　
環境変数を指定して実行する場合は、コマンドの前に変数名とその値を指定する、下記の形式で記述します。
　

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

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

　
Windows上の XAMPP環境で実行する場合は、「/bin」フォルダに移動して、下記のコマンド形式で記述します。
　

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

1 2	// コマンドの前に環境変数を指定する場合 $ set CAKE_ENV=develop& cake SampleTests getList

　
Windows環境になって変わるのは、「set」と「&」を付けるところです。
　
　
※コマンドライン上では「//」はコメント行にはなりませんが、便宜上、PHPのコメントの記述方法を利用しています。
　
　

コマンドプロンプトで環境変数を指定する方法の詳細解説

Linuxと Windowsでコマンド実行時に環境変数を設定する記述方法の違い

　
改めて Linuxと XAMPPでのコマンドを並べてみました。
　

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

// XAMPPでコマンドの前に環境変数を指定する場合
$ set CAKE_ENV=develop& cake SampleTests getList

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

$ CAKE_ENV=develop bin/cake SampleTests getList

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

$ set CAKE_ENV=develop& cake SampleTests getList

Windowsの環境変数の設定方法は 2つのコマンドをつなげて実行している

　
Windows環境での「set CAKE_ENV=develop& cake SampleTests getList」は、下記のコマンド 2つを 1行で実行していることになります。（2つのコマンドとして別々に実行しても問題なく実行できます。）
　

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

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

$ set CAKE_ENV=develop

$ cake SampleTests getList

　
Linuxの場合、複数のコマンドを 1行で実行する場合は「;（セミコロン）」で区切りますが、Windowsの場合は「&（アンパサンド）」で区切りますので、上記のコマンド 2つを 1行で実行する場合は下記となります。
　

// XAMPPでコマンドの前に環境変数を指定する場合
$ set CAKE_ENV=develop& cake SampleTests getList

1 2	// XAMPPでコマンドの前に環境変数を指定する場合 $ set CAKE_ENV=develop& cake SampleTests getList

環境変数を設定して 2つ目のコマンドを実行する際の最重要ポイント

　
ここで非常に重要なポイントとしては「&」と「develop」の間にはスペースを入れない、ということです。
　

// コマンド実行時の間違いの記述方法
$ set CAKE_ENV=develop & cake SampleTests getList

1 2	// コマンド実行時の間違いの記述方法 $ set CAKE_ENV=develop & cake SampleTests getList

　
上記のように「develop」と「&」との間にスペースがあると、「CAKE_ENV」の値として保存される値は「develop」＋「半角スペース」となってしまいます。
　
　
そのため、上記の間違いの記述方法で実行すると、下記の if文が「false」となってしまいます。
「$_SERVER["CAKE_ENV"]」の値には半角スペースが入っていますので。
　

if ( $_SERVER["CAKE_ENV"] == "develop" ) {
  echo "True";
} else {
  echo "False";
}

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

echo "True";

} else {

echo "False";

}

　
　
私はこの「&」の前に空白を入れてはいけない、ということに気づかず延々と悩んでいました。
この後解説しますが、設定されている環境変数を確認するコマンドでもスペースの有無は確認できないのです．．．
　
　

Windowsの setで設定した環境変数はウインドウを閉じるまで有効

　
解説したように、Windowsで環境変数は「set 変数名=値」と言う形式で設定しますが、設定した環境変数の有効期限は、そのコマンドラインのウインドウを閉じるまで有効になっています。
　
そのため、一度環境変数を設定したウインドウのコマンドラインからは、下記のコマンドを実行するだけで設定した環境変数が有効な状態で処理を実行します。
　

$ cake SampleTests getList

1	$ cake SampleTests getList

　
また、Windowを閉じると環境変数は削除されます。
　
　

Windows環境で setコマンドを使って環境変数を設定、確認、変更、削除する方法

setで設定した環境変数を確認する方法

　
setで設定した内容を確認したい場合は「set」だけを入力します。
「set」だけ入力すると設定されている環境変数すべてが表示されます。
　

// 設定してあるすべての環境変数を表示する
$ set

// findstrを使って grepする
$ set | findstr "CAKE_ENV"

// 設定してあるすべての環境変数を表示する

$ set

// findstrを使って grepする

$ set | findstr "CAKE_ENV"

　
「set」だけだとすべての環境変数が表示されますので、探すのが面倒です。
そんな場合は「findstr」を使って条件抽出をするといいでしょう。
Windowsには「grep」コマンドがありませんので、代わりに「findstr」を使用します。
　
　
findstrコマンドについて詳しく知りたい方は下記のオフィシャルサイトが参考になるかと思います。
https://learn.microsoft.com/ja-jp/windows-server/administration/windows-commands/findstr
　
　

setで設定した環境変数を削除する方法

　
「set」で設定した環境変数を削除したい場合は、下記のように値を空白にしてコマンドを実行します。
これで「CAKE_ENV」と言う環境変数自体が削除されます。
　

$ set CAKE_ENV=

1	$ set CAKE_ENV=

　
　
環境変数の有効期間はウインドウを開いている間ですので、コマンドラインのウインドウを閉じると消去されます。
また、設定した環境変数は設定したウインドウのみ有効ですので、別のコマンドラインのウインドウを開いてもそちら側では環境変数は設定されていない状態になっています。
　
　

setで設定した環境変数を変更する方法

　
「set」で設定した環境変数を変更したい場合は、設定する時と同じ記述方法で値を上書きします。
　

$ set CAKE_ENV=production

1	$ set CAKE_ENV=production

setで設定した環境変数を恒久的な値とする方法

　
「set」は一時的に環境変数を設定するコマンドですが、これを恒久的な値とするコマンドとして「setx」が用意されています。
　
ただ、「setx」で作成した変数は削除できないようなので、「set」コマンドでその都度設定する方がよさそうです。
「setx」についての問題点については下記が参考になるかと思います。
https://qiita.com/jeyei/items/05ce2739501832463b3b
　
　
プログラムで使用する環境変数などは「setx」コマンドを使うより、Windowsの「設定」から「環境変数を編集」で検索をして、「環境変数」を設定するウインドウで環境変数を設定する方が問題は少ないだろうと思います。
　
　