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

Copy
1<?php
2
3/**
4 * 現在のウェブページのURL情報を表示します。
5 *
6 * この関数は、$_SERVER['PHP_SELF'] を用いて現在のスクリプトパスを取得し、
7 * parse_url() 関数と PHP_URL_HOST 定数を使用して、URLからホスト名を抽出する方法を示します。
8 * システムエンジニアを目指す初心者向けに、WebアプリケーションでのURL情報の扱い方を
9 * 理解しやすいように構成されています。
10 */
11function displayCurrentUrlInfo(): void
12{
13    // 現在のホスト名を取得します。$_SERVER['HTTP_HOST'] はリクエストヘッダーから
14    // ホスト名（例: example.com や localhost:8000）を取得します。
15    // PHP 7.0以降の null 合体演算子 (??) を使用して、値が存在しない場合のデフォルトを設定します。
16    $host = $_SERVER['HTTP_HOST'] ?? 'localhost';
17
18    // 現在実行中のスクリプトのパスを取得します。
19    // $_SERVER['PHP_SELF'] は、Webサイトのルートからのスクリプトのパスです。
20    // 例: /my_project/index.php
21    $scriptPath = $_SERVER['PHP_SELF'] ?? '/index.php';
22
23    // 現在のプロトコル (http:// または https://) を判断します。
24    $protocol = (!empty($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off' || $_SERVER['SERVER_PORT'] == 443) ? "https://" : "http://";
25
26    // 完全な現在のURLを構築します。
27    $currentUrl = $protocol . $host . $scriptPath;
28
29    echo "<h2>現在のURL情報</h2>";
30    // $_SERVER['PHP_SELF'] の内容を表示します。
31    echo "<p><strong>現在のスクリプトパス ($_SERVER['PHP_SELF']):</strong> " . htmlspecialchars($scriptPath) . "</p>";
32    // 構築された完全なURLを表示します。
33    echo "<p><strong>構築された完全なURL:</strong> " . htmlspecialchars($currentUrl) . "</p>";
34
35    // URLを解析し、ホスト部分を抽出します。
36    // parse_url() 関数は、URLを構成する様々な部分（スキーマ、ホスト、パスなど）に分解します。
37    // PHP_URL_HOST 定数を第二引数に指定することで、URLのホスト名のみを抽出できます。
38    // PHP_URL_HOST は、parse_url() にどの部分を返すか指示するためのフラグ定数です。
39    $parsedHost = parse_url($currentUrl, PHP_URL_HOST);
40
41    // 解析結果が有効な場合に表示します。
42    if ($parsedHost !== false && $parsedHost !== null) {
43        echo "<p><strong>解析されたURLホスト (PHP_URL_HOST):</strong> " . htmlspecialchars($parsedHost) . "</p>";
44    } else {
45        echo "<p>URLホストの解析に失敗しました。</p>";
46    }
47}
48
49// 定義した関数を実行し、ブラウザに出力を表示します。
50displayCurrentUrlInfo();
51
52?>

このサンプルコードは、PHPで現在のウェブページのURL情報を取得し、その中から特にホスト名を抽出する方法を、システムエンジニアを目指す初心者向けに示しています。まず、PHPの組み込み変数$_SERVERを用いて、現在のホスト名や実行中のスクリプトのパス（$_SERVER['PHP_SELF']）を取得し、完全なURLを構築しています。$_SERVER['PHP_SELF']は、現在のスクリプトがウェブサイトのルートから見てどこにあるかを示すパスです。

構築されたURLから特定の情報を抽出するために、parse_url()関数が使用されます。この関数は、与えられたURLを「スキーム（http/https）」「ホスト」「パス」などの各要素に分解する役割を持ちます。PHP_URL_HOSTは、このparse_url()関数の第二引数として指定する特別な定数です。PHP_URL_HOST自体には引数や戻り値はありませんが、parse_url()関数に渡すことで、「URL全体からホスト名だけを抜き出してほしい」という指示を出すことができます。これにより、parse_url()関数は解析されたホスト名を文字列として返します。ウェブアプリケーション開発において、URLの各部分を正確に扱う技術は非常に重要です。

Copy
1<?php
2
3/**
4 * 指定されたURLからホスト名を取得し、
5 * HTTP認証が行われている場合はそのユーザー名を表示します。
6 * システムエンジニアを目指す初心者向けに、PHPの定数とスーパーグローバル変数の使用例を示します。
7 *
8 * @param string $url 処理するURL
9 */
10function displayUrlHostAndAuthUser(string $url): void
11{
12    // PHP_URL_HOST は、parse_url() 関数の第2引数として使用される定数です。
13    // この定数を使うことで、URL文字列からホスト名部分だけを抽出するように指示します。
14    // parse_url() 関数は、URLを解析し、指定されたコンポーネント（ここではホスト名）を返します。
15    $host = parse_url($url, PHP_URL_HOST);
16
17    echo "対象URL: " . $url . "\n";
18    echo "  - 抽出されたホスト名: " . ($host ?? '取得できませんでした') . "\n";
19
20    // $_SERVER['PHP_AUTH_USER'] は、HTTP Basic認証やDigest認証が成功した場合に
21    // 認証されたユーザー名が自動的に格納されるPHPのスーパーグローバル変数です。
22    // この情報はWebサーバーによって設定され、スクリプト内でアクセスできます。
23    if (isset($_SERVER['PHP_AUTH_USER'])) {
24        $authUser = $_SERVER['PHP_AUTH_USER'];
25        echo "  - 認証ユーザー名: " . $authUser . "\n";
26    } else {
27        echo "  - 認証ユーザー名: なし (HTTP認証は行われていません)\n";
28        // 補足: 実際にHTTP認証をトリガーするには、Webサーバーの設定または
29        // header('WWW-Authenticate: Basic realm="Restricted Area"');
30        // header('HTTP/1.0 401 Unauthorized');
31        // といったHTTPヘッダーを送信する必要があります。
32    }
33}
34
35// --- 単体動作のためのサンプル ---
36
37// 実際のWebサーバー環境をシミュレートするため、
38// $_SERVER['PHP_AUTH_USER'] に一時的に値を設定します。
39// 実際の環境では、Webサーバーが認証成功時にこの値を設定します。
40$_SERVER['PHP_AUTH_USER'] = 'developer_john';
41
42// 処理するサンプルURL
43$sampleUrl = 'https://secure.api.example.com/data/report.php?type=daily';
44
45// 関数を呼び出して情報を表示します。
46displayUrlHostAndAuthUser($sampleUrl);
47
48?>

このサンプルコードは、与えられたURLからホスト名を取得し、さらにHTTP認証が行われている場合のユーザー名を表示する方法を示しています。

PHP_URL_HOST は、PHPが提供する定数の一つです。これは、parse_url() 関数と組み合わせて使用され、URL文字列の中からホスト名（例: example.com）だけを抽出するように指示します。parse_url() 関数は、第1引数に解析したいURL、第2引数に PHP_URL_HOST などの定数を指定することで、対応するURLの構成要素を文字列として返します。

displayUrlHostAndAuthUser 関数は、引数として受け取った $url 文字列を処理します。この関数は処理結果をコンソールに出力するだけで、特定の値を返さないため、戻り値の型は void と宣言されています。

また、$_SERVER['PHP_AUTH_USER'] は、PHPのスーパーグローバル変数の一つです。WebサーバーがHTTP Basic認証やDigest認証に成功した場合に、認証されたユーザー名が自動的にこの変数に格納されます。サンプルコードでは、この変数がセットされているかを確認し、値があればその認証ユーザー名を表示しています。これにより、URLの特定部分の抽出と、Webサーバーが提供する認証情報の利用方法について学ぶことができます。