エス技研

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


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

      2024/06/23

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

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

 
 

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

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

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

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

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

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

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

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

 

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

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

 
 

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

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

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

 
 

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

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

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

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

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

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

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

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

 

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

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

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

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

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

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

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

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

 
 

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

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

CakePHP4の関連記事

CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説
CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法
Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法
CakePHP4で複数の引数(パラメータ)を付与してコマンドを実行する方法
CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説
CakePHP4 でコマンドプログラム(シェルプログラム)を作成する方法解説
Windows環境の XAMPPを利用して CakePHPの開発する際の注意点
CakePHP4の規約外のカラムをキーにアソシエーション(テーブル連結)する方法
CakePHPで Auto Incrementを外すと Duplicate entry '0' for keyのエラーが出るかも
CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因
 
その他の「CakePHP4」に関する記事一覧
 
 

 - CakePHP 3.x 4.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

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

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

  関連記事

CakePHP 2.3 Search Pluginで検索処理 その7queryを使って 日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

CakePHP 2.3 ログイン、操作履歴、アクセスログ出力

CakePHPでログインや操作履歴などのアクセスログ出力処理を作成します。

CakePHP 2.3 テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション(連携)している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

CakePHP3で値を入力直後にバリデーションする方法解説
CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

CakePHP 2.3でOn Duplicate Key構文を実装

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

CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応
CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する。
VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する

VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。

CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

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

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

MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL+CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。