【PHP8.x】DOMComment::normalize()メソッドの使い方

Copy
1<?php
2
3/**
4 * 電話番号を国際形式 (E.164) に正規化します。
5 *
6 * - 電話番号から数字以外の文字をすべて除去します。
7 * - 国コードに基づき、日本の電話番号 (0から始まる) を +81 形式に変換します。
8 * - 既に国際形式 (+で始まる) の場合は、数字以外の文字のみ除去します。
9 *
10 * @param string $phoneNumber 正規化する電話番号の文字列。
11 * @param string $defaultCountryCode デフォルトの国コード (例: 'JP' -> +81)。
12 * @return string 正規化された電話番号。無効な入力の場合は空文字列を返します。
13 */
14function normalizePhoneNumber(string $phoneNumber, string $defaultCountryCode = 'JP'): string
15{
16    // 1. 電話番号から数字以外の文字をすべて除去します。
17    $digitsOnly = preg_replace('/\D/', '', $phoneNumber);
18
19    if (empty($digitsOnly)) {
20        return ''; // 数字が一つもない場合は無効な入力として空文字列を返します。
21    }
22
23    // 主要な国コードと国際プレフィックスのマッピング
24    // 必要に応じて他の国を追加してください。
25    $countryCodes = [
26        'JP' => '81', // 日本
27        'US' => '1',  // アメリカ
28        'GB' => '44', // イギリス
29        'FR' => '33', // フランス
30        'DE' => '49', // ドイツ
31    ];
32
33    // 指定された国コードに対応する国際プレフィックスを取得します。
34    $internationalPrefix = $countryCodes[strtoupper($defaultCountryCode)] ?? null;
35
36    // 2. 既に国際形式 (例: +81...) の場合は、数字以外の文字を除去したものを返します。
37    // 例: "+81 90 1234 5678" -> "819012345678"
38    // digitsOnly が国際プレフィックスで始まるかを確認します。
39    if ($internationalPrefix && str_starts_with($digitsOnly, $internationalPrefix)) {
40        return '+' . $digitsOnly;
41    }
42
43    // 3. 国コードが利用可能で、かつ0から始まる国内番号の場合、
44    // 最初の0を除去し、国コードを付与して国際形式に変換します。
45    // 例: "090-1234-5678" (JP) -> "+819012345678"
46    if ($internationalPrefix && str_starts_with($digitsOnly, '0')) {
47        return '+' . $internationalPrefix . substr($digitsOnly, 1);
48    }
49
50    // 4. その他のケース (国コードは有効だが、上記パターンに当てはまらない場合)
51    // 例えば、アメリカ国内で市外局番から始まる番号など。
52    // 例: "123-456-7890" (US) -> "+11234567890"
53    if ($internationalPrefix) {
54        return '+' . $internationalPrefix . $digitsOnly;
55    }
56
57    // 5. 指定された国コードに対応するプレフィックスが見つからない場合、
58    // または国際形式への変換が適切でないと判断された場合、数字のみを返します。
59    // この場合、E.164形式には完全には正規化されません。
60    return $digitsOnly;
61}
62
63// --- 使用例 ---
64
65// 例1: 日本の携帯電話番号 (ハイフンあり)
66$phone1 = "090-1234-5678";
67echo "Original: " . $phone1 . PHP_EOL;
68echo "Normalized (JP): " . normalizePhoneNumber($phone1, 'JP') . PHP_EOL . PHP_EOL;
69
70// 例2: 既に国際形式の日本の電話番号 (スペースあり)
71$phone2 = "+81 90 5555 1111";
72echo "Original: " . $phone2 . PHP_EOL;
73echo "Normalized (JP): " . normalizePhoneNumber($phone2, 'JP') . PHP_EOL . PHP_EOL;
74
75// 例3: 0から始まる日本の市外局番
76$phone3 = "03-1234-5678";
77echo "Original: " . $phone3 . PHP_EOL;
78echo "Normalized (JP): " . normalizePhoneNumber($phone3, 'JP') . PHP_EOL . PHP_EOL;
79
80// 例4: アメリカの電話番号 (ハイフンあり)
81$phone4 = "123-456-7890";
82echo "Original: " . $phone4 . PHP_EOL;
83echo "Normalized (US): " . normalizePhoneNumber($phone4, 'US') . PHP_EOL . PHP_EOL;
84
85// 例5: イギリスの電話番号 (カッコとスペースあり)
86$phone5 = "(0)20 7946 0958";
87echo "Original: " . $phone5 . PHP_EOL;
88echo "Normalized (GB): " . normalizePhoneNumber($phone5, 'GB') . PHP_EOL . PHP_EOL;
89
90// 例6: 国コードが指定できない、または不明な場合 (数字のみを返す)
91$phone6 = "111-222-3333";
92echo "Original: " . $phone6 . PHP_EOL;
93echo "Normalized (Unknown Country): " . normalizePhoneNumber($phone6, 'UNKNOWN') . PHP_EOL . PHP_EOL;
94
95// 例7: 無効な入力 (数字なし)
96$phone7 = "abc-def";
97echo "Original: " . $phone7 . PHP_EOL;
98echo "Normalized (Invalid): " . normalizePhoneNumber($phone7) . PHP_EOL . PHP_EOL;
99
100?>

このPHPサンプルコードは、様々な形式で入力される電話番号を国際形式（E.164）に統一するnormalizePhoneNumber関数の実装を示しています。PHPにおけるデータの「正規化」処理の具体的な一例として、システムエンジニアを目指す方にとって実用的な内容です。

normalizePhoneNumber関数は、正規化したい電話番号の文字列を第一引数として受け取り、オプションでデフォルトの国コード（例: 'JP'）を第二引数で指定できます。関数内部では、まず入力された電話番号からハイフンやスペースといった数字以外の文字をすべて除去します。次に、指定された国コード（例えば'JP'であれば日本の国コード「81」）に基づいて、日本の国内番号「090-1234-5678」のような「0」から始まる番号を、最初の「0」を除去して国コードを付与し、「+819012345678」といった国際形式に変換します。もし電話番号が既に「+81 90 5555 1111」のように国際形式で入力されている場合も、数字以外の文字を除去して一貫した形式に整えられます。指定された国コードに対応するプレフィックスが見つからない場合や、変換パターンに合致しない場合は、数字のみの文字列を返します。関数の戻り値は、正規化された電話番号の文字列です。入力された電話番号に数字が一つも含まれない無効な場合は、空文字列を返します。このように、異なる形式のデータを統一する正規化処理は、システムで情報を正確に管理するために非常に重要です。

Copy
1<?php
2
3// DOMDocumentオブジェクトを初期化します。
4// XML宣言を1.0、エンコーディングをUTF-8に設定します。
5$dom = new DOMDocument('1.0', 'UTF-8');
6$dom->formatOutput = true; // 出力を見やすく整形します。
7
8// ルート要素（例: html）を作成し、DOMドキュメントに追加します。
9$htmlElement = $dom->createElement('html');
10$dom->appendChild($htmlElement);
11
12// コメントノードを作成します。
13$commentNode = $dom->createComment("これはテストコメントです。");
14
15// 作成したコメントノードをHTML要素の子として追加します。
16$htmlElement->appendChild($commentNode);
17
18echo "--- normalize() 呼び出し前のXML ---" . PHP_EOL;
19echo $dom->saveXML() . PHP_EOL;
20
21// DOMComment オブジェクトに対して normalize() メソッドを呼び出します。
22// DOMNodeから継承された normalize() メソッドは、通常、
23// 隣接するDOMTextノードを結合したり、空のDOMTextノードを削除したりするために使用されます。
24// しかし、DOMCommentノード自体は子にDOMTextノードを持たないため、
25// このメソッドをDOMCommentオブジェクトに対して直接呼び出しても、
26// コメントノードの内容に目に見える変化は生じません。
27$commentNode->normalize();
28
29echo "--- normalize() 呼び出し後のXML ---" . PHP_EOL;
30echo $dom->saveXML() . PHP_EOL;
31
32// コメントノードの内容は normalize() によって変化しないことを確認できます。
33echo "コメントノードの内容: " . $commentNode->nodeValue . PHP_EOL;
34
35?>

PHPのDOMComment::normalize()メソッドは、DOM（Document Object Model）ツリーの構造を正規化するために使用されるメソッドです。このメソッドは引数を取らず、戻り値もありません。

本来、DOMNodeクラスから継承されたnormalize()は、DOMツリー内の隣接するDOMTextノードを結合したり、空のDOMTextノードを削除したりすることで、ツリーの表現を簡潔にする役割があります。

しかし、DOMCommentはXMLやHTMLのコメントを表すノードであり、その内部に子ノードとしてテキストノードを持つことはありません。そのため、サンプルコードが示すように、DOMCommentオブジェクトに対してnormalize()を呼び出しても、コメントノードの内容自体に変化は生じません。

サンプルコードでは、DOMDocumentにコメントノードを追加し、normalize()呼び出し前後でXML出力を比較しています。結果、コメントノードの内容に変化がないことが確認でき、DOMComment::normalize()がコメントノードには影響を与えないことを実証しています。このメソッドは、主にテキストノードの最適化に用いられると理解してください。

Copy
1<?php
2
3/**
4 * DOMComment::normalize() メソッドのサンプルコード
5 *
6 * この関数は、DOMCommentクラスのnormalize()メソッドの基本的な使い方を示します。
7 * DOMComment::normalize() は、親クラスである DOMNode::normalize() を継承しています。
8 * DOMNode::normalize() の主な目的は、隣接するTextノードを結合し、空のTextノードを削除することです。
9 *
10 * しかし、DOMCommentノードはその性質上、子ノードとしてTextノードを持つことができません。
11 * したがって、DOMCommentインスタンスに対してnormalize()メソッドを呼び出しても、
12 * 実際にはノードの内容や構造に目に見える変更は発生しません。
13 *
14 * 注意: 「php normalizer インストール」というキーワードがありますが、
15 * これは Intl 拡張の Normalizer クラスを指すことが多いです。
16 * DOMComment は DOM 拡張の一部であり、PHP の多くの環境でデフォルトで有効になっているため、
17 * 通常、特別なインストールは不要です。
18 */
19function demonstrateDomCommentNormalize(): void
20{
21    // 新しい DOMDocument インスタンスを作成
22    $dom = new DOMDocument('1.0', 'UTF-8');
23
24    // コメントノードを作成します。
25    // コメントの内容はDOMCommentノードの "data" プロパティに保持されます。
26    $commentText = " このコメントはDOMComment::normalize()のデモです。 ";
27    $commentNode = $dom->createComment($commentText);
28
29    echo "--- DOMComment::normalize() メソッドのデモンストレーション ---" . PHP_EOL;
30
31    // 作成したコメントノードをDOMDocumentに追加します (normalize呼び出し自体には必須ではないが、一般的な使い方)。
32    $dom->appendChild($commentNode);
33
34    // normalize() 呼び出し前のコメントノードの内容を表示
35    echo "normalize() 呼び出し前のデータ: '" . $commentNode->data . "'" . PHP_EOL;
36
37    // DOMComment::normalize() メソッドを呼び出します。
38    // このメソッドは引数を取りません。
39    // DOMCommentノードにはText子ノードが存在しないため、この操作によるDOM構造上の変更は発生しません。
40    $commentNode->normalize();
41
42    // normalize() 呼び出し後のコメントノードの内容を表示
43    echo "normalize() 呼び出し後のデータ: '" . $commentNode->data . "'" . PHP_EOL;
44
45    // 実際には内容に変化がないことを確認できます。
46}
47
48// 関数を実行します。
49demonstrateDomCommentNormalize();

DOMComment::normalize()メソッドは、PHPのDOM拡張機能に属するDOMCommentクラスのメソッドです。このメソッドは引数なしで呼び出され、戻り値もありません。

本メソッドは親クラスであるDOMNode::normalize()を継承しており、本来はDOMツリー内の隣接するテキストノードを結合したり、空のテキストノードを削除したりしてツリーを整理する役割があります。しかし、DOMCommentノードは子ノードとしてテキストノードを持たないため、DOMCommentインスタンスに対してnormalize()を呼び出しても、ノードの内容や構造は変化しません。

「php normalizer インストール」というキーワードは、通常、Unicodeの文字列正規化を行うIntl拡張のNormalizerクラスを指します。DOMCommentが属するDOM拡張は多くのPHP環境でデフォルトで有効なため、特別なインストールは不要です。