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

Copy
1<?php
2
3/**
4 * IPアドレスの形式を検証するサンプルコード。
5 *
6 * filter_var() 関数を使用して、指定された文字列が有効なIPアドレス形式であるかを確認します。
7 * FILTER_VALIDATE_IP はIPアドレスの検証を行うフィルタで、
8 * FILTER_FLAG_NONE は追加の検証フラグを指定しないことを意味します。
9 * フラグを指定しない場合、IPv4とIPv6の両方が検証の対象となります。
10 */
11
12// 検証対象となるIPアドレスの例をいくつか定義
13$ipAddressValidIPv4 = '192.168.1.100';
14$ipAddressValidIPv6 = '2001:0db8:85a3:0000:0000:8a2e:0370:7334';
15$ipAddressInvalid = 'not-an-ip-address';
16
17echo "--- IPアドレス検証の例 ---" . PHP_EOL . PHP_EOL;
18
19/**
20 * 指定されたIPアドレスを検証し、結果を出力する関数。
21 *
22 * @param string $ipAddress 検証するIPアドレス文字列
23 * @return void
24 */
25function validateIpAddress(string $ipAddress): void
26{
27    // filter_var() を使用してIPアドレスを検証
28    // FILTER_VALIDATE_IP はIPアドレス形式の検証を行うフィルタ
29    // FILTER_FLAG_NONE は追加のフラグ（例: IPv4のみ、IPv6のみ）を指定しないことを意味する
30    $isValid = filter_var($ipAddress, FILTER_VALIDATE_IP, FILTER_FLAG_NONE);
31
32    echo "検証対象: '{$ipAddress}'" . PHP_EOL;
33
34    // 検証結果の出力
35    if ($isValid !== false) {
36        echo "  結果: 有効なIPアドレスです。" . PHP_EOL;
37    } else {
38        echo "  結果: 無効なIPアドレスです。" . PHP_EOL;
39    }
40    echo PHP_EOL;
41}
42
43// 各IPアドレスの検証を実行
44validateIpAddress($ipAddressValidIPv4);
45validateIpAddress($ipAddressValidIPv6);
46validateIpAddress($ipAddressInvalid);
47

このサンプルコードは、PHP 8で提供されるfilter_var()関数を使って、指定された文字列が有効なIPアドレス形式であるかを検証する方法を示しています。filter_var()関数は、検証したい文字列を第一引数に、検証方法を指定するフィルターを第二引数に取ります。ここではFILTER_VALIDATE_IPが指定されており、これがIPアドレスの形式検証を行うフィルターです。

第三引数には、さらに詳細な検証条件を指定するためのフラグを渡すことができますが、このコードではFILTER_FLAG_NONEを使用しています。FILTER_FLAG_NONEは、PHPの拡張機能の一部として定義されている定数で、特別な追加フラグを指定しないことを意味します。これにより、検証対象のIPアドレスはIPv4形式とIPv6形式の両方が有効として扱われます。

filter_var()関数の戻り値は、検証が成功した場合は元の文字列（有効なIPアドレス）、失敗した場合はfalseです。この戻り値がfalseかどうかを判断することで、プログラムはIPアドレスの有効性を簡単に確認できます。システムエンジニアにとって、ユーザーからの入力データの妥当性をチェックする際に、このようなIPアドレス検証は頻繁に利用される基本的な処理の一つです。

Copy
1<?php
2
3/**
4 * 入力文字列が有効な浮動小数点数であるかを確認する関数。
5 *
6 * FILTER_FLAG_NONE は、filter_var() 関数で追加のフラグを指定しない場合に使用する定数です。
7 * これは、フィルタリング処理において特別なオプションを適用しないことを明示します。
8 * 通常、追加のフラグが不要な場合は、この引数を省略しても同じ結果になります。
9 *
10 * @param string $inputString 検証する入力文字列。
11 * @return void
12 */
13function validateFloatWithNoSpecificFlags(string $inputString): void
14{
15    // FILTER_VALIDATE_FLOAT は、入力が有効な浮動小数点数（例: "123.45", "100", "3.14e-5"）であるかを検証します。
16    // 第3引数に FILTER_FLAG_NONE を指定することで、
17    // カンマを許可する(FILTER_FLAG_ALLOW_THOUSAND)などの特別なフラグを適用しないことを示します。
18    $filteredValue = filter_var($inputString, FILTER_VALIDATE_FLOAT, FILTER_FLAG_NONE);
19
20    // filter_var() は、検証に成功した場合にフィルタリングされた値（この場合は浮動小数点数）を返し、
21    // 失敗した場合は bool(false) を返します。
22    if ($filteredValue !== false) {
23        echo "入力 '{$inputString}' は有効な浮動小数点数です: " . $filteredValue . PHP_EOL;
24    } else {
25        echo "入力 '{$inputString}' は有効な浮動小数点数ではありません。" . PHP_EOL;
26    }
27}
28
29// --- サンプルコードの実行 ---
30
31// 有効な浮動小数点数の例
32validateFloatWithNoSpecificFlags("123.45");
33
34// 整数も浮動小数点数として有効と判断されます
35validateFloatWithNoSpecificFlags("100");
36
37// 負の数も有効です
38validateFloatWithNoSpecificFlags("-98.76");
39
40// 指数表記も有効です
41validateFloatWithNoSpecificFlags("3.14e-5");
42
43// 無効な入力の例
44validateFloatWithNoSpecificFlags("abc");
45validateFloatWithNoSpecificFlags("1.2.3");
46validateFloatWithNoSpecificFlags("1,234.56"); // カンマはデフォルトでは無効（FILTER_FLAG_ALLOW_THOUSANDが必要）
47validateFloatWithNoSpecificFlags("");
48

このPHPサンプルコードは、与えられた文字列が「有効な浮動小数点数」であるかを検証する方法を示しています。 主な役割を果たすのはfilter_var()関数です。この関数は、PHPで入力データの検証やサニタイズを行うための組み込み関数です。 filter_var()関数の第二引数にはFILTER_VALIDATE_FLOATが指定されており、これは入力された値が浮動小数点数として適切な形式であるかをチェックするよう指示しています。例えば、「123.45」や「-98.76」、「3.14e-5」のような形式が有効と判断されます。 第三引数にはFILTER_FLAG_NONEが使用されています。この定数は、「フィルタリング処理において、特別なオプションを一切適用しない」ということを明示します。例えば、数値中のカンマを許可するFILTER_FLAG_ALLOW_THOUSANDのような追加フラグを適用しない場合に使用します。これにより、標準的な浮動小数点数の検証が行われます。 filter_var()関数は、検証が成功した場合にはフィルタリングされた値（この場合は浮動小数点数）を返し、検証に失敗した場合にはbool(false)を返します。 サンプルコードでは、この戻り値がfalseでないかを確認することで、入力文字列が有効な浮動小数点数であるかを判断し、その結果を画面に表示しています。 validateFloatWithNoSpecificFlags関数は、$inputStringとして検証したい文字列を受け取りますが、戻り値はvoidであるため、検証結果は関数内で直接出力されます。