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

Copy
1<?php
2
3/**
4 * PHPのインストールプレフィックスを表示します。
5 *
6 * PHP_PREFIX は、PHPがシステムにインストールされた際の
7 * ベースパス（例: /usr/local）を示す組み込み定数です。
8 * これはPHPがどのディレクトリに配置されているかという、
9 * PHP環境に関する基本的な情報の一つです。
10 *
11 * この値は、PHPがCLI (Command Line Interface) で実行されているか、
12 * WebサーバーのSAPI (Server API) 経由で実行されているかに関わらず、
13 * PHPのビルド時に設定されたインストールパスを返します。
14 *
15 * @return void
16 */
17function displayPhpInstallPrefix(): void
18{
19    // PHP_PREFIX 定数の値を取得し、出力
20    // この定数はPHPのビルド時に設定されるインストールパスを表します。
21    echo "PHP のインストールプレフィックス: " . PHP_PREFIX . "\n";
22}
23
24// 関数を実行して、PHPのインストールプレフィックスを表示します。
25displayPhpInstallPrefix();

PHP_PREFIXは、PHP 8に組み込まれている定数で、PHPがシステムにインストールされた際のベースパスを示します。これは、PHPが例えば/usr/localのようなルートディレクトリ配下のどこにインストールされているかを示すもので、PHP環境を理解するための基本的な情報の一つです。

この定数には引数はなく、PHPのインストールプレフィックスを文字列（string）として返します。PHPがCLI（コマンドラインインターフェース）から実行される場合でも、WebサーバーのSAPI（Server API）経由で実行される場合でも、PHPのビルド時に設定されたインストールパスが常に同じ値として得られます。

サンプルコードでは、displayPhpInstallPrefix関数を定義し、その中でPHP_PREFIX定数の値を取得して画面に表示しています。この関数を実行することで、現在動作しているPHPのインストールベースパスを簡単に確認でき、システムにおけるPHPの配置状況を把握したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * 現在のPHP実行環境に関する基本情報を表示します。
5 *
6 * この関数は、PHPが動作しているSAPI (Server API) の種類と、
7 * PHPがインストールされているプレフィックスパスを出力します。
8 * システムエンジニア初心者がPHPの実行環境を理解するのに役立ちます。
9 */
10function showPhpEnvironmentDetails(): void
11{
12    // php_sapi_name() は、現在PHPが動作しているSAPI (Server API) の名前を返します。
13    // 例: 'cli' (コマンドライン), 'fpm-fcgi' (PHP-FPM), 'apache2handler' (Apacheモジュール) など。
14    $currentSapi = php_sapi_name();
15
16    // PHP_PREFIX は、PHPがインストールされているディレクトリのプレフィックスパスを返すグローバル定数です。
17    // 例: '/usr/local', '/opt/php8' など。
18    // この定数は引数なしで、string型の値を返します。
19    $phpInstallPrefix = PHP_PREFIX;
20
21    echo "現在のPHP実行環境情報:\n";
22    echo "--------------------------\n";
23    echo "SAPI (Server API) の種類: " . $currentSapi . "\n";
24    echo "PHPインストールプレフィックスパス: " . $phpInstallPrefix . "\n";
25    echo "--------------------------\n";
26}
27
28// 定義した関数を呼び出し、PHP環境の詳細を表示します。
29showPhpEnvironmentDetails();
30
31?>

このサンプルコードは、PHPの現在の実行環境に関する基本情報を表示します。システムエンジニアを目指す初心者の方がPHPの動作環境を理解するのに役立つ内容です。

コード内のshowPhpEnvironmentDetails関数は、主に二つの情報を取得して出力します。一つ目は、php_sapi_name()関数を用いて取得されるSAPI (Server API) の種類です。この関数は引数を取らず、PHPが現在どのようなインターフェースで動作しているかを示す文字列を返します。例えば、コマンドラインで実行していればcli、WebサーバーのPHP-FPM経由であればfpm-fcgiのような値が戻り値として得られます。

二つ目は、PHP_PREFIXというグローバル定数から取得されるPHPのインストールプレフィックスパスです。この定数も引数はなく、PHPがシステム上のどの基本パスにインストールされているかを示す文字列を返します。例えば、/usr/localや/opt/php8といったパスがこれに該当します。

これらの取得された情報は、echo文によって画面に出力され、現在のPHP環境のSAPIの種類とインストールパスが分かりやすく表示されます。これにより、ご自身のPHP環境がどのように設定されているかを視覚的に確認することができます。