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

Copy
1<?php
2
3/**
4 * URLからホスト名とポート番号を抽出し、表示する関数。
5 *
6 * この関数は、`parse_url()`関数と`PHP_URL_HOST`、`PHP_URL_PORT`定数を使用して、
7 * 指定されたURLからホスト名とポート番号を安全に抽出します。
8 * システムエンジニアを目指す初心者向けに、URL解析の基本を示します。
9 *
10 * @param string $url 解析対象のURL文字列。
11 * @return void
12 */
13function displayUrlHostAndPort(string $url): void
14{
15    echo "--- 解析対象URL: " . $url . " ---\n";
16
17    // parse_url() を使用してURLからホスト名を抽出します。
18    // PHP_URL_HOST は、URLのホスト部分 (例: www.example.com) を取得するための定数です。
19    $host = parse_url($url, PHP_URL_HOST);
20
21    // parse_url() を使用してURLからポート番号を抽出します。
22    // PHP_URL_PORT は、URLのポート部分 (例: 8080) を取得するための定数です。
23    // ポートが明示されていない場合は null が返されます。
24    $port = parse_url($url, PHP_URL_PORT);
25
26    // ホスト名の表示
27    // parse_url() は解析に失敗した場合や該当コンポーネントがない場合に false や null を返します。
28    if ($host !== false && $host !== null) {
29        echo "ホスト名: " . $host . "\n";
30    } else {
31        echo "ホスト名: 見つかりませんでした。\n";
32    }
33
34    // ポート番号の表示
35    if ($port !== false && $port !== null) {
36        echo "ポート番号: " . $port . "\n";
37    } else {
38        echo "ポート番号: 見つかりませんでした (デフォルトのポートが使用されている可能性があります)。\n";
39    }
40    echo "\n";
41}
42
43// サンプルURLで関数を実行
44displayUrlHostAndPort('https://www.example.com:8080/path/to/page?query=value#fragment');
45displayUrlHostAndPort('http://localhost/index.php'); // ポートが明示されていない例
46displayUrlHostAndPort('ftp://user:pass@ftp.example.org:21/pub/file.txt');
47displayUrlHostAndPort('http://192.168.1.1:80'); // IPアドレスとポートの例
48displayUrlHostAndPort('invalid-url-string'); // 無効なURLの例

PHP_URL_PORTは、PHP 8で利用できる拡張機能の一部である定数です。この定数は、URL文字列から特定のコンポーネント、特にポート番号を抽出する際に使用されます。主にparse_url()関数と組み合わせて利用され、与えられたURLからポート番号の部分を安全に取得する役割を担います。

例えば、parse_url($url, PHP_URL_PORT)のように記述することで、指定されたURLに含まれるポート番号（例: 8080）を取り出すことができます。URLにポート番号が明示されていない場合や、解析に失敗した場合には、parse_url()関数はnullやfalseを返します。

この定数と同様に、URLのホスト名を取得するにはPHP_URL_HOST定数が使用されます。これらの定数とparse_url()関数を組み合わせることで、URLの各要素を正確に解析し、ウェブアプリケーションでURLを安全に処理する基盤となります。システムエンジニアを目指す初心者にとって、URLの構造を理解し、その構成要素をプログラムで安全に扱うための基本的な手法として非常に重要です。

Copy
1<?php
2
3/**
4 * 現在のWebページのURLからポート番号を抽出し、表示します。
5 *
6 * この関数は、現在のリクエスト情報（$_SERVERスーパーグローバル変数）を利用して
7 * 完全なURLを構築し、PHPのparse_url()関数とPHP_URL_PORT定数を用いて
8 * ポート番号を正確に取得する方法を示します。
9 * システムエンジニアを目指す初心者向けに、URLの構成要素とPHP定数の practical な利用例を提供します。
10 */
11function displayCurrentUrlPort(): void
12{
13    // 現在のリクエストスキーム（httpまたはhttps）を決定します。
14    // PHP 8では$_SERVER['REQUEST_SCHEME']が推奨されますが、古い環境との互換性も考慮できます。
15    $scheme = isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on' ? 'https' : 'http';
16    if (isset($_SERVER['REQUEST_SCHEME'])) {
17        $scheme = $_SERVER['REQUEST_SCHEME'];
18    }
19
20    // ホスト名と、もし存在すればポート番号を含む部分を取得します (例: example.com または localhost:8080)。
21    $host = $_SERVER['HTTP_HOST'];
22
23    // 現在実行中のスクリプトのパスを取得します（キーワード: php_self）。
24    // 例: /my_app/index.php
25    $path = $_SERVER['PHP_SELF'];
26
27    // 上記の要素を組み合わせて完全なURLを構築します。
28    // 例: http://localhost:8080/my_app/index.php
29    $fullUrl = "{$scheme}://{$host}{$path}";
30
31    echo "現在の完全なURL: " . htmlspecialchars($fullUrl) . "\n";
32
33    // parse_url() 関数と PHP_URL_PORT 定数を使用して、URLからポート番号を抽出します。
34    // PHP_URL_PORT は、URLのポート部分のみを抽出するようにparse_url()に指示する定数です。
35    $port = parse_url($fullUrl, PHP_URL_PORT);
36
37    if ($port !== null) {
38        echo "URLから抽出されたポート番号: " . htmlspecialchars((string)$port) . "\n";
39    } else {
40        // ポート番号がURLに明示されていない場合 (例: HTTPの80番、HTTPSの443番など)、
41        // parse_url() は null を返します。
42        echo "URLにポート番号は明示されていません (標準ポートを使用している可能性があります)。\n";
43    }
44}
45
46// 上記で定義した関数を実行し、結果を表示します。
47displayCurrentUrlPort();
48

PHPのPHP_URL_PORTは、URLの構成要素から「ポート番号」を抽出するために使用される定数です。この定数自体に引数や戻り値はなく、他の関数と組み合わせて利用されます。

サンプルコードでは、まず現在のWebページの完全なURLを構築しています。$_SERVERスーパーグローバル変数を用いて、通信スキーム（httpやhttps）、ホスト名、そして現在のスクリプトのパス（PHP_SELF）を取得し、これらを組み合わせて"http://example.com:8080/path/to/script.php"のようなURL文字列を作成しています。

次に、構築したURL文字列をparse_url()関数に渡します。parse_url()関数はURLを「スキーム」「ホスト」「ポート」「パス」などの個別の構成要素に分解する役割を持ちます。この関数の第二引数にPHP_URL_PORT定数を指定することで、parse_url()関数はURLからポート番号のみを抽出し、整数として返します。

例えば、URLがhttp://localhost:8080/index.phpの場合、PHP_URL_PORTを指定すると8080というポート番号が取得されます。もしURLにポート番号が明示されていない場合（例: http://example.com/のようにHTTPの標準ポート80番やHTTPSの標準ポート443番を使用している場合）、parse_url()関数はnullを返します。このサンプルコードは、現在のURLからポート番号を正確に取得し、その結果を表示する実用的な方法を示しています。