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

Copy
1<?php
2
3/**
4 * PHP_URL_FRAGMENT 定数を使用してURLのフラグメント部分を抽出するサンプル。
5 *
6 * PHP_URL_FRAGMENT は、parse_url() 関数の第2引数に指定することで、
7 * URLの '#' (シャープ) 以降の部分（アンカーやフラグメントと呼ばれる）を
8 * 抽出するために使用される定数です。
9 */
10function demonstrateUrlFragmentExtraction(): void
11{
12    // フラグメント部分を含むサンプルURLを定義します。
13    // フラグメントはURLの末尾に '#' で区切られて記述されます。
14    $urlWithFragment = 'https://www.example.com/path/to/page?query=value#section-id';
15
16    echo "元のURL: " . $urlWithFragment . PHP_EOL;
17
18    // parse_url() 関数と PHP_URL_FRAGMENT 定数を使用して、
19    // URLからフラグメント部分のみを抽出します。
20    $fragment = parse_url($urlWithFragment, PHP_URL_FRAGMENT);
21
22    // 抽出されたフラグメント部分を表示します。
23    // フラグメントが存在しない場合は null が返されるため、
24    // ?? 'なし' を使って分かりやすく表示します。
25    echo "抽出されたフラグメント部分 (PHP_URL_FRAGMENT): " . ($fragment ?? 'なし') . PHP_EOL;
26
27    echo PHP_EOL; // 見やすくするための改行
28
29    // フラグメント部分が含まれないURLの例
30    $urlWithoutFragment = 'https://www.example.com/another/page';
31
32    echo "元のURL (フラグメントなし): " . $urlWithoutFragment . PHP_EOL;
33
34    // フラグメントがないURLから抽出を試みると null が返されます。
35    $fragmentNo = parse_url($urlWithoutFragment, PHP_URL_FRAGMENT);
36
37    echo "抽出されたフラグメント部分 (PHP_URL_FRAGMENT): " . ($fragmentNo ?? 'なし') . PHP_EOL;
38}
39
40// 関数を実行して、URLフラグメント抽出の動作を確認します。
41demonstrateUrlFragmentExtraction();
42

このサンプルコードは、PHPのPHP_URL_FRAGMENT定数を利用して、URLから特定の情報「フラグメント」を抽出する方法を紹介しています。PHP_URL_FRAGMENTは、URLを解析するparse_url()関数の第2引数に指定することで、URLの「#（シャープ）」以降の部分（フラグメント）を取り出すための定数です。この定数自体には引数はなく、内部的に整数値として定義されています。

URLのフラグメントは、ウェブページ内の特定の場所を指し示すために使われる部分です。例えば「#section-id」のように記述されます。

サンプルコードでは、まずフラグメントを含むURLと、フラグメントを含まないURLの二つのケースを定義しています。parse_url()関数にURLとPHP_URL_FRAGMENT定数を指定すると、URLからフラグメント部分が文字列として戻り値で返されます。具体的には、「#section-id」というフラグメントを持つURLからは「section-id」という文字列が抽出されます。

もしURLにフラグメントが存在しない場合、parse_url()関数は戻り値としてnullを返します。コード中ではこの挙動も確認でき、抽出結果がnullの場合に「なし」と表示されるように「?? 'なし'」というNull合体演算子が使用されています。このようにPHP_URL_FRAGMENT定数を用いることで、URLから必要な特定の情報を簡単かつ正確に取得し、プログラムで利用することが可能です。

Copy
1<?php
2
3/**
4 * URLからフラグメント部分を抽出する関数
5 *
6 * この関数は、PHPのparse_url()関数とPHP_URL_FRAGMENT定数を使用し、
7 * URLのシャープ記号（#）以降のフラグメント部分を取得する方法を示します。
8 * PHP_URL_FRAGMENT定数は、parse_url()関数の第2引数として渡すことで、
9 * URLの特定のコンポーネント（この場合はフラグメント）のみを抽出するよう指示します。
10 *
11 * @param string $url 解析対象のURL文字列
12 * @return string|null フラグメント部分の文字列、またはフラグメントが存在しない場合はnull
13 */
14function extractUrlFragment(string $url): ?string
15{
16    // parse_url()関数は、与えられたURLを構成要素に分解します。
17    // 第2引数にPHP_URL_FRAGMENT定数を指定すると、URLのフラグメント部分のみを抽出します。
18    // フラグメントは、URLの'#'記号（ハッシュ記号）に続く部分です。
19    $fragment = parse_url($url, PHP_URL_FRAGMENT);
20
21    // フラグメントが存在しない場合、parse_url()はnullを返します。
22    // 存在する場合は、フラグメント部分の文字列を返します。
23    return $fragment;
24}
25
26// --- 使用例 ---
27
28// フラグメント（#section-id）とパス（/path/to/resource）を含むURLの例
29$sampleUrlWithFragment = 'https://www.example.com/path/to/resource?param=value#section-id';
30$extractedFragment = extractUrlFragment($sampleUrlWithFragment);
31
32echo "元のURL: " . $sampleUrlWithFragment . "\n";
33if ($extractedFragment !== null) {
34    echo "抽出されたフラグメント: " . $extractedFragment . "\n"; // 出力: section-id
35} else {
36    echo "フラグメントは見つかりませんでした。\n";
37}
38echo "\n"; // 見やすいように改行
39
40// フラグメントを含まないURLの例
41$sampleUrlWithoutFragment = 'http://localhost/another/path/index.html?id=123';
42$extractedFragment = extractUrlFragment($sampleUrlWithoutFragment);
43
44echo "元のURL: " . $sampleUrlWithoutFragment . "\n";
45if ($extractedFragment !== null) {
46    echo "抽出されたフラグメント: " . $extractedFragment . "\n";
47} else {
48    echo "フラグメントは見つかりませんでした。\n"; // 出力: フラグメントは見つかりませんでした。
49}
50
51?>

このPHPサンプルコードは、URL（Uniform Resource Locator）から「フラグメント」と呼ばれる特定の情報部分を正確に抽出する方法を、システムエンジニアを目指す初心者の方にもわかりやすく示しています。

URLのフラグメントとは、通常、シャープ記号（#）以降に続く文字列のことで、ウェブページ内の特定のセクションやアンカーポイントを示す目的で利用されます。このコードの中心的な役割を果たすのが、PHP 8で利用可能なPHP_URL_FRAGMENTという定数です。この定数自体は、PHPの内部でURLの特定のコンポーネント（ここではフラグメント）を識別するための整数値（int）として定義されており、引数は持ちません。

サンプル内のextractUrlFragment関数は、引数として解析対象の$url文字列を受け取ります。その内部では、PHP標準関数のparse_url()を使用し、第2引数にPHP_URL_FRAGMENT定数を指定しています。これにより、parse_url()関数は、与えられたURL全体からフラグメント部分のみを抽出し、その結果を返します。

この関数の戻り値は、フラグメントがURL内に存在する場合、そのフラグメント部分の文字列（例: section-id）となります。もしURLにフラグメントが含まれていない場合、parse_url()関数はnullを返すため、extractUrlFragment関数も同様にnullを返します。この挙動は、コードの使用例で、フラグメントを持つURLと持たないURLの両方で確認できます。PHP_URL_FRAGMENT定数を用いることで、URL解析処理を効率的かつ明確に記述することが可能です。