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

Copy
1<?php
2
3/**
4 * 指定されたIPアドレスがIPv6として有効であるかを検証します。
5 *
6 * FILTER_FLAG_IPV6定数を使用し、IPv6アドレスの検証に特化します。
7 * PHPのfilter_var関数とFILTER_VALIDATE_IPフィルターを組み合わせて利用します。
8 *
9 * @param string $ipAddress 検証するIPアドレス文字列。
10 * @return string IPアドレスがIPv6として有効であれば "有効なIPv6アドレスです。"、
11 *                そうでなければ "無効なIPv6アドレスです。" を返します。
12 */
13function validateIpv6Address(string $ipAddress): string
14{
15    // filter_var関数のオプションを定義します。
16    // 'flags'キーにFILTER_FLAG_IPV6を指定することで、
17    // IPv6アドレスのみを有効と判断するように設定します。
18    // このフラグがない場合、IPv4アドレスも有効と判断されます。
19    $options = [
20        'flags' => FILTER_FLAG_IPV6
21    ];
22
23    // filter_var関数でIPアドレスを検証します。
24    // 第一引数: 検証対象のデータ
25    // 第二引数: 適用するフィルター (ここではIPアドレス検証)
26    // 第三引数: フィルターに渡すオプション (ここではIPv6フラグ)
27    if (filter_var($ipAddress, FILTER_VALIDATE_IP, $options) !== false) {
28        return "有効なIPv6アドレスです。";
29    } else {
30        return "無効なIPv6アドレスです。";
31    }
32}
33
34// --- サンプル使用例 ---
35
36// 有効なIPv6アドレスの例
37$validIpv6 = "2001:0db8:85a3:0000:0000:8a2e:0370:7334";
38echo "アドレス: " . $validIpv6 . " => " . validateIpv6Address($validIpv6) . PHP_EOL;
39
40// 別の有効なIPv6アドレスの例 (ループバックアドレスの短縮形)
41$validIpv6Short = "::1";
42echo "アドレス: " . $validIpv6Short . " => " . validateIpv6Address($validIpv6Short) . PHP_EOL;
43
44// 無効なIPv6アドレスの例 (不正な文字が含まれる)
45$invalidIpv6Char = "2001:0db8:85a3:G000:0000:8a2e:0370:7334";
46echo "アドレス: " . $invalidIpv6Char . " => " . validateIpv6Address($invalidIpv6Char) . PHP_EOL;
47
48// IPv4アドレスの例 (FILTER_FLAG_IPV6が指定されているため、無効と判断されます)
49$ipv4Address = "192.168.1.100";
50echo "アドレス: " . $ipv4Address . " => " . validateIpv6Address($ipv4Address) . PHP_EOL;
51
52// 不完全なIPv6アドレスの例
53$incompleteIpv6 = "2001:db8::";
54echo "アドレス: " . $incompleteIpv6 . " => " . validateIpv6Address($incompleteIpv6) . PHP_EOL;
55
56?>

このPHPコードは、入力された文字列が有効なIPv6アドレスであるかを検証する方法を示しています。PHP 8で導入されたFILTER_FLAG_IPV6定数を使用することで、IPv6アドレスの形式に特化した検証が可能になります。

この検証の中心となるのは、PHPの組み込み関数filter_varです。この関数は、さまざまなデータをフィルターにかけるために使用され、ここでは第二引数にFILTER_VALIDATE_IPを指定することで、入力がIPアドレスとして正しい形式であるかをチェックします。さらに重要なのは、第三引数のオプション配列で'flags' => FILTER_FLAG_IPV6を設定している点です。この設定により、filter_var関数はIPv4アドレスを無効と判断し、IPv6アドレスのみを有効なIPアドレスとして認識するようになります。もしこのフラグが指定されていない場合、IPv4アドレスも有効と判断されます。

validateIpv6Address関数は、検証したいIPアドレス文字列を$ipAddress引数として受け取ります。関数内部では、前述のfilter_var関数とFILTER_FLAG_IPV6フラグを組み合わせてIPアドレスの検証を行い、結果に基づいて文字列を返します。具体的には、IPアドレスがIPv6として有効であれば「有効なIPv6アドレスです。」、そうでなければ「無効なIPv6アドレスです。」という文字列を戻り値として返します。この機能は、WebアプリケーションでユーザーからのIPアドレス入力を検証する際や、ネットワーク関連の処理でIPアドレスの形式を確認する際に役立ちます。

Copy
1<?php
2
3/**
4 * 指定された文字列が有効なIPv6アドレスであるかを検証します。
5 *
6 * FILTER_VALIDATE_IP フィルターと FILTER_FLAG_IPV6 フラグを使用し、
7 * IPv6アドレスのみを許可して検証します。
8 *
9 * @param string $ipAddress 検証するIPアドレス文字列
10 * @return bool 有効なIPv6アドレスであれば true、そうでなければ false
11 */
12function isValidIpv6Address(string $ipAddress): bool
13{
14    // filter_var 関数は、指定された変数をフィルタリングします。
15    //
16    // 第一引数 ($ipAddress): 検証したいIPアドレス文字列。
17    // 第二引数 (FILTER_VALIDATE_IP): IPアドレスの形式を検証するためのフィルター定数。
18    // 第三引数 (FILTER_FLAG_IPV6): フィルターに追加のオプション（フラグ）を指定します。
19    //                            このフラグは、IPアドレスの検証をIPv6形式に限定します。
20    //
21    // 成功した場合はフィルタリングされた値（元のIPアドレス文字列）、
22    // 失敗した場合は false を返します。
23    // 結果を明確にブール値として返すため、(bool) でキャストしています。
24    return (bool) filter_var(
25        $ipAddress,
26        FILTER_VALIDATE_IP,
27        FILTER_FLAG_IPV6
28    );
29}
30
31// --- サンプル使用例 ---
32
33echo "IPv6アドレス検証の実行例:" . PHP_EOL;
34echo "----------------------" . PHP_EOL;
35
36// 有効なIPv6アドレスの例
37$ipv6Valid1 = "2001:0db8:85a3:0000:0000:8a2e:0370:7334";
38$ipv6Valid2 = "::1"; // IPv6のループバックアドレス
39$ipv6Valid3 = "fe80::1ff:fe23:4567:890a"; // リンクローカルアドレス
40
41// 無効なIPv6アドレスの例
42$ipv6Invalid1 = "2001:db8::1::1"; // IPv6では '::' は一度しか使えません
43$ipv6Invalid2 = "2001:db8:a:b:c:d:e:f:g"; // 不正な文字が含まれる
44
45// IPv4アドレスの例 (この関数ではIPv6として無効と判定される)
46$ipv4Address = "192.168.1.1";
47
48echo "IPアドレス: '{$ipv6Valid1}' はIPv6として有効ですか？ ";
49var_dump(isValidIpv6Address($ipv6Valid1)); // 期待値: true
50
51echo "IPアドレス: '{$ipv6Valid2}' はIPv6として有効ですか？ ";
52var_dump(isValidIpv6Address($ipv6Valid2)); // 期待値: true
53
54echo "IPアドレス: '{$ipv6Valid3}' はIPv6として有効ですか？ ";
55var_dump(isValidIpv6Address($ipv6Valid3)); // 期待値: true
56
57echo "IPアドレス: '{$ipv6Invalid1}' はIPv6として有効ですか？ ";
58var_dump(isValidIpv6Address($ipv6Invalid1)); // 期待値: false
59
60echo "IPアドレス: '{$ipv6Invalid2}' はIPv6として有効ですか？ ";
61var_dump(isValidIpv6Address($ipv6Invalid2)); // 期待値: false
62
63echo "IPアドレス: '{$ipv4Address}' はIPv6として有効ですか？ ";
64var_dump(isValidIpv6Address($ipv4Address)); // 期待値: false (IPv4なので)
65

このPHPサンプルコードは、指定された文字列が有効なIPv6アドレスであるかを効率的に検証する方法を示しています。ここでは、PHPの組み込み関数filter_varと、それに付随する定数FILTER_VALIDATE_IPおよびFILTER_FLAG_IPV6を使用します。

filter_var関数は、変数に特定のフィルターを適用して検証またはサニタイズするために広く用いられます。このコードでは、第一引数に検証したいIPアドレス文字列を、第二引数にIPアドレス形式を検証するフィルターであるFILTER_VALIDATE_IPを指定しています。さらに、第三引数にはFILTER_FLAG_IPV6というフラグを渡しています。このFILTER_FLAG_IPV6フラグは、FILTER_VALIDATE_IPフィルターがIPアドレスを検証する際、その形式をIPv6アドレスに限定する役割を持っています。

isValidIpv6Address関数は、検証したいIPアドレス文字列を引数 $ipAddress として受け取ります。内部ではfilter_varが実行され、成功した場合は元のIPアドレス文字列、失敗した場合はfalseを返します。この結果をブール値（trueまたはfalse）として明確に返すため、(bool)で型キャストしています。これにより、この関数は有効なIPv6アドレスであればtrue、そうでなければfalseを戻り値として返します。サンプルコードでは、様々なIPv6アドレスやIPv4アドレスを検証し、その挙動を確認できます。