【PHP8.x】ini_get関数の使い方

<?php

/**
 * PHPの全てのINI設定情報を取得し、表示するサンプルコードです。
 *
 * ini_get_all() 関数は、PHPの実行環境における全てのINI設定オプションを
 * 連想配列の形式で返します。各設定オプションは、その名前をキーとし、
 * グローバル値、ローカル値、アクセスレベルなどの詳細情報を含む
 * サブ配列として格納されています。
 *
 * この関数は、システムエンジニアを目指す初心者がPHP環境の設定を
 * 確認し、理解する上で非常に役立ちます。
 */
function displayAllIniSettings(): void
{
    // ini_get_all() を使用して、PHPの全てのINI設定情報を取得します。
    // 引数を指定しない場合、全てのINI設定が詳細情報と共に返されます。
    $iniSettings = ini_get_all();

    // INI設定情報の取得に失敗した場合の処理
    if ($iniSettings === false) {
        echo "INI設定情報の取得に失敗しました。\n";
        return;
    }

    echo "--- PHP INI 設定一覧 ---\n";

    // 取得した設定情報をループで処理し、整形して表示します。
    foreach ($iniSettings as $key => $value) {
        // 'local_value' は現在のスクリプト実行スコープにおける設定値です。
        // 'global_value' はPHPが起動時に読み込んだINIファイルからの設定値です。
        // 空文字列の場合は、'(empty)' と表示して分かりやすくします。
        $localValue = (string)($value['local_value'] ?? 'N/A');
        $globalValue = (string)($value['global_value'] ?? 'N/A');

        echo sprintf(
            "%-30s : Local = %-15s | Global = %-15s\n",
            $key,
            ($localValue === '' ? '(empty)' : $localValue),
            ($globalValue === '' ? '(empty)' : $globalValue)
        );
    }
    echo "-------------------------\n";
}

// 上記で定義した関数を実行し、PHPのINI設定情報を表示します。
displayAllIniSettings();

ini_get_all()関数は、PHPの実行環境における全てのINI設定オプションを詳細情報とともに取得する際に使用します。引数を指定しない場合、PHPに設定されている全てのオプションが連想配列として返されます。各オプションは、その名前をキーとし、現在のスクリプト実行スコープでの設定値を示すlocal_valueや、PHP起動時に読み込まれたINIファイルからの設定値を示すglobal_valueなどの情報を含むサブ配列として格納されます。

戻り値は、設定情報が格納された配列、または情報の取得に失敗した場合はfalseとなります。この関数を利用することで、PHP環境の設定状況を網羅的に確認し、それぞれの設定が現在どのように適用されているかを把握できます。

サンプルコードでは、ini_get_all()で取得した全てのINI設定情報をループ処理し、各設定の名前とlocal_value、global_valueを比較しやすい形式で整形して表示しています。これにより、システムエンジニアを目指す初心者が自身のPHP環境設定を効率的に理解し、デバッグや環境構築に役立てることができます。

<?php

/**
 * PHPのini設定ディレクティブの現在の値を取得し、表示する関数。
 * システムエンジニアを目指す初心者向けに、ini_get関数の基本的な使い方を示します。
 * ini_getは、php.iniファイルやその他の設定ファイルで定義されたPHPの設定値を取得するために使用されます。
 */
function displayPhpIniSettings(): void
{
    echo "PHP ini設定値の取得例:\n";
    echo "--------------------------\n";

    // display_errors: エラーを画面に出力するかどうか
    $displayErrors = ini_get('display_errors');
    if ($displayErrors !== false) {
        echo "display_errors: " . ($displayErrors ? 'On' : 'Off') . "\n";
    } else {
        echo "display_errors: 設定が見つからないか、取得できませんでした。\n";
    }

    // memory_limit: スクリプトが消費できる最大メモリ量
    $memoryLimit = ini_get('memory_limit');
    if ($memoryLimit !== false) {
        echo "memory_limit: " . $memoryLimit . "\n";
    } else {
        echo "memory_limit: 設定が見つからないか、取得できませんでした。\n";
    }

    // upload_max_filesize: アップロードできるファイルの最大サイズ
    $uploadMaxFilesize = ini_get('upload_max_filesize');
    if ($uploadMaxFilesize !== false) {
        echo "upload_max_filesize: " . $uploadMaxFilesize . "\n";
    } else {
        echo "upload_max_filesize: 設定が見つからないか、取得できませんでした。\n";
    }

    // 存在しない設定を取得しようとした場合
    $nonExistentSetting = ini_get('non_existent_php_setting');
    if ($nonExistentSetting !== false) {
        echo "non_existent_php_setting: " . $nonExistentSetting . "\n";
    } else {
        echo "non_existent_php_setting: (設定が見つからないか、取得できませんでした。これは期待される動作です。)\n";
    }

    echo "--------------------------\n";
}

// 関数を実行して、設定値を確認します。
displayPhpIniSettings();

?>

PHPのini_get関数は、PHPが動作する環境における様々な設定値を取得するために使用されます。これらの設定は、通常php.iniファイルなどで定義されており、スクリプトのエラー表示方法や利用可能なメモリ量など、PHPの挙動を細かく制御しています。

この関数は、引数として取得したい設定項目の名前を文字列で受け取ります。例えば、エラーを画面に出力するかどうかを設定するdisplay_errorsや、スクリプトが消費できる最大のメモリ量を指定するmemory_limitなどがこれにあたります。

設定値の取得に成功した場合、その値が文字列として返されます。サンプルコードでは、display_errorsが「On」または「Off」として、またmemory_limitやupload_max_filesizeが具体的な値として取得されている様子が示されています。しかし、指定した設定項目が存在しない場合や、何らかの理由で値が取得できない場合は、falseが戻り値として返されます。サンプルコードの最後に示すように、存在しない設定項目を問い合わせた際にfalseが返されることで、設定値の有無をプログラムで確認する際の重要な判断基準となります。ini_get関数を使うことで、実行環境の設定に応じてスクリプトの動作を調整する基礎を学ぶことができます。