【PHP8.x】PHP_SAPI定数の使い方

Copy
1<?php
2
3/**
4 * 現在の PHP Server API (SAPI) の種類を表示する関数。
5 *
6 * PHP_SAPI 定数は、PHP がどのような環境で実行されているか（例: コマンドライン、
7 * Apacheモジュール、PHP-FPMなど）を示す文字列を提供します。
8 * これは、PHPスクリプトがWebサーバーを介して実行されているのか、
9 * コマンドラインから直接実行されているのかなどを区別するのに役立ちます。
10 */
11function displayCurrentPhpSapi(): void
12{
13    // PHP_SAPI 定数には、PHPが実行されているServer API (SAPI) の名前が格納されています。
14    // 例: コマンドラインで実行されていれば 'cli'、Apache Webサーバーモジュールなら 'apache2handler' など。
15    $sapiName = PHP_SAPI;
16
17    // 取得したSAPIの名前を画面に出力します。
18    // PHP_EOL は、現在のOSに適した改行コード (Windowsなら \r\n, Linuxなら \n) を提供します。
19    echo "現在の PHP SAPI (Server API) の種類: " . $sapiName . PHP_EOL;
20}
21
22// 関数を実行して、現在の PHP SAPI の種類を表示します。
23displayCurrentPhpSapi();

PHP_SAPIは、PHPプログラムがどのような環境で実行されているかを示す文字列を格納している定数です。この定数を使うことで、PHPがWebサーバーのモジュールとして動作しているのか、コマンドラインから直接実行されているのか、あるいはPHP-FPMなどの特定のサービスとして動いているのかを区別できます。

例えば、コマンドラインでスクリプトを実行した場合は「cli」という値が、Apache Webサーバーを通じて実行した場合は「apache2handler」のような値が格納されます。これは、PHPスクリプトを開発する際に、実行環境によって異なる処理を行いたい場合に非常に役立ちます。

サンプルコードでは、PHP_SAPI定数の値を$sapiNameという変数に代入し、その内容を画面に表示しています。出力時に使用しているPHP_EOLは、実行環境のOSに合わせた適切な改行コードを提供する定数です。PHP_SAPIは定数であるため引数を取らず、常に現在のSAPI名を表す文字列を戻り値として返します。