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

Copy
1<?php
2
3/**
4 * 指定された文字列が有効なMACアドレス形式であるかを検証します。
5 * システムエンジニアを目指す初心者の方のために、
6 * PHPのフィルター関数 `filter_var` と定数 `FILTER_VALIDATE_MAC` の基本的な使い方を示します。
7 *
8 * @param string $macAddress 検証するMACアドレス文字列
9 * @return bool MACアドレスが有効な形式であれば true、そうでなければ false
10 */
11function isValidMacAddress(string $macAddress): bool
12{
13    // filter_var関数とFILTER_VALIDATE_MAC定数を使用してMACアドレスを検証します。
14    // FILTER_VALIDATE_MACは、コロン区切り (XX:XX:XX:XX:XX:XX) またはハイフン区切り (XX-XX-XX-XX-XX-XX)
15    // の形式のMACアドレスを認識します。
16    // 有効なMACアドレスであればその文字列を返し、無効な場合は false を返します。
17    return filter_var($macAddress, FILTER_VALIDATE_MAC) !== false;
18}
19
20// 以下はサンプルコードの動作確認のための使用例です。
21// さまざまなMACアドレス形式を試して結果を確認できます。
22echo "--- MACアドレス検証のサンプル ---" . PHP_EOL;
23
24// 有効なMACアドレスの例
25$validMac1 = '00:1A:2B:3C:4D:5E'; // コロン区切り
26$validMac2 = 'F0-A1-B2-C3-D4-E5'; // ハイフン区切り
27
28// 無効なMACアドレスの例
29$invalidMac1 = '00:1A:2B:3C:4D';      // 短すぎる
30$invalidMac2 = 'GG:1A:2B:3C:4D:5E';    // 無効な文字 (G) が含まれる
31$invalidMac3 = '001A2B3C4D5E';        // 区切り文字がない
32$emptyMac    = '';                    // 空の文字列
33
34echo "MACアドレス: '{$validMac1}' は有効ですか？ " . (isValidMacAddress($validMac1) ? 'はい' : 'いいえ') . PHP_EOL;
35echo "MACアドレス: '{$validMac2}' は有効ですか？ " . (isValidMacAddress($validMac2) ? 'はい' : 'いいえ') . PHP_EOL;
36echo "MACアドレス: '{$invalidMac1}' は有効ですか？ " . (isValidMacAddress($invalidMac1) ? 'はい' : 'いいえ') . PHP_EOL;
37echo "MACアドレス: '{$invalidMac2}' は有効ですか？ " . (isValidMacAddress($invalidMac2) ? 'はい' : 'いいえ') . PHP_EOL;
38echo "MACアドレス: '{$invalidMac3}' は有効ですか？ " . (isValidMacAddress($invalidMac3) ? 'はい' : 'いいえ') . PHP_EOL;
39echo "MACアドレス: '{$emptyMac}' は有効ですか？ " . (isValidMacAddress($emptyMac) ? 'はい' : 'いいえ') . PHP_EOL;
40

このサンプルコードは、PHPの組み込み関数filter_varと定数FILTER_VALIDATE_MACを利用して、与えられた文字列が有効なMACアドレス形式であるかを検証する方法を説明しています。FILTER_VALIDATE_MACは、特にMACアドレスの形式チェックに特化したフィルター定数です。

filter_var関数は、第一引数に検証したい文字列、第二引数にFILTER_VALIDATE_MACを指定することで、その文字列がMACアドレスの規則に則っているかを判断します。この定数を用いると、XX:XX:XX:XX:XX:XXのようなコロン区切り、またはXX-XX-XX-XX-XX-XXのようなハイフン区切りのMACアドレス形式が有効と見なされます。

filter_var関数は、有効なMACアドレス形式であれば入力された文字列をそのまま返し、無効な形式であればfalseを戻り値として返します。サンプルコード中のisValidMacAddress関数は、この挙動を利用しており、引数として受け取ったMACアドレス候補の文字列が有効な形式であればtrueを、そうでなければfalseを返します。

コードの下部にある使用例では、実際にさまざまなMACアドレスの文字列をisValidMacAddress関数に渡し、コロン区切りやハイフン区切りの有効な形式、あるいは文字数不足や不正な文字が含まれる無効な形式に対して、検証結果がどのように出力されるかを確認できます。これにより、この関数の具体的な使い方と動作を理解することができます。

Copy
1<?php
2
3/**
4 * MACアドレスの妥当性を検証する関数です。
5 * システムエンジニアを目指す初心者が入力値検証の基本を理解できるように、
6 * PHPの filter_var 関数と FILTER_VALIDATE_MAC 定数を使用します。
7 *
8 * FILTER_VALIDATE_MAC は、指定された文字列が標準的なMACアドレス形式
9 * (例: 00:1A:2B:3C:4D:5E または 00-1A-2B-3C-4D-5E) であるかを検査します。
10 * filter_var 関数は内部的に適切な正規表現（キーワードの 'regex' に関連）を使用してこの検証を行います。
11 *
12 * @param string $macAddress 検証するMACアドレス文字列
13 * @return bool 有効なMACアドレスであれば true、そうでなければ false
14 */
15function validateMacAddress(string $macAddress): bool
16{
17    // filter_var関数は、変数を特定のフィルターで処理するために使用されます。
18    // ここでは、MACアドレスの形式が正しいかを検証するために FILTER_VALIDATE_MAC フィルターを使用します。
19    //
20    // 参考: 同様に、メールアドレスの検証には FILTER_VALIDATE_EMAIL フィルターが使用できます。
21    // 例: filter_var($email, FILTER_VALIDATE_EMAIL)
22    //
23    // 検証が成功すると元の値が返され、失敗すると false が返されます。
24    // そのため、結果が false でないことを確認して真偽値を返します。
25    return filter_var($macAddress, FILTER_VALIDATE_MAC) !== false;
26}
27
28// 単体で動作可能なサンプルコードとして、複数のMACアドレスを検証します。
29echo "--- MACアドレス検証テスト ---\n";
30
31// 検証対象となるMACアドレスのリスト
32$testMacAddresses = [
33    '00:1A:2B:3C:4D:5E',         // 有効なコロン区切り
34    'A1-B2-C3-D4-E5-F6',         // 有効なハイフン区切り
35    '00:1A:2B:3C:4D:5G',         // 無効: 'G' は16進数ではない
36    '00:1A:2B:3C:4D',            // 無効: 長さが足りない
37    'not-a-mac-address',         // 無効: 全く異なる形式
38    '00-11-22-33-44-55-66',      // 無効: 長すぎる
39    'aa:bb:cc:dd:ee:ff',         // 有効: 小文字でも認識
40];
41
42foreach ($testMacAddresses as $mac) {
43    if (validateMacAddress($mac)) {
44        echo sprintf("'%s' は有効なMACアドレスです。\n", $mac);
45    } else {
46        echo sprintf("'%s' は無効なMACアドレスです。\n", $mac);
47    }
48}
49
50echo "---------------------------\n";
51
52?>

このサンプルコードは、PHPのfilter_var関数とFILTER_VALIDATE_MAC定数を用いて、文字列が有効なMACアドレス形式であるかを検証する方法を、システムエンジニアを目指す初心者向けに説明しています。

FILTER_VALIDATE_MACは、PHPのフィルター拡張機能で提供される定数で、引数は持ちません。この定数をfilter_var関数の第二引数として使用すると、指定された文字列が標準的なMACアドレスの書式（例：00:1A:2B:3C:4D:5EやA1-B2-C3-D4-E5-F6）に沿っているかを検査します。この検証は、内部的に適切な正規表現（regex）を用いて行われます。

validateMacAddress関数では、引数として受け取ったMACアドレス文字列$macAddressをfilter_var関数に渡し、FILTER_VALIDATE_MACフィルターを適用しています。filter_var関数は、検証に成功した場合は元の入力値を返し、失敗した場合はブール値falseを返します。そのため、本関数ではfilter_varの戻り値がfalseではないことを確認し、有効なMACアドレスであればtrueを、無効であればfalseをブール値として返しています。これは、filter_varが返すint型の値（成功時の入力値）を、最終的に利用しやすいbool型に変換していることを意味します。同様に、メールアドレスの検証にはFILTER_VALIDATE_EMAIL定数を使用できます。

サンプルコードの後半では、具体的なMACアドレスの例を複数用意し、validateMacAddress関数を通してそれぞれの検証結果を出力することで、動作を確認できるようにしています。