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

Copy
1<?php
2
3/**
4 * 電話番号を国際標準E.164形式に正規化します。
5 *
6 * 不要な文字を除去し、指定されたデフォルト国コードに基づいて
7 * 番号を標準化された形式（例: +819012345678）に変換します。
8 *
9 * @param string $phoneNumber 正規化する電話番号。
10 * @param string $defaultCountryCode 国コード（例: 日本の場合は '81'）。
11 * @return string 正規化された電話番号。不正な入力の場合は空文字列を返します。
12 */
13function normalizePhoneNumber(string $phoneNumber, string $defaultCountryCode = '81'): string
14{
15    // 1. 数字以外の文字をすべて除去します。
16    $cleanedNumber = preg_replace('/[^0-9]/', '', $phoneNumber);
17
18    if (empty($cleanedNumber)) {
19        return ''; // 数字が含まれていない場合は処理せずに空文字列を返します。
20    }
21
22    // 2. 国際ダイヤルプレフィックスや国内番号のルールに基づいて正規化します。
23    if (str_starts_with($cleanedNumber, '00')) {
24        // 例: '001819012345678' -> '+819012345678'
25        // '00'で始まる国際ダイヤルプレフィックスを除去し、'+'を付与します。
26        $normalizedNumber = '+' . substr($cleanedNumber, 2);
27    } elseif (str_starts_with($cleanedNumber, '0') && strlen($cleanedNumber) > 1) {
28        // 例: '09012345678' -> '+819012345678' (日本の国内番号と仮定)
29        // 先頭の '0' を除去し、デフォルトの国コードを付与します。
30        $normalizedNumber = '+' . $defaultCountryCode . substr($cleanedNumber, 1);
31    } elseif (!str_starts_with($cleanedNumber, '+')) {
32        // 例: '819012345678' (既に国際形式の国コードから始まっていると仮定)
33        // または、国コードが既に含まれているが '+' がない場合や、
34        // 国内番号の先頭 '0' がない場合など。簡略化のため '+' を付与します。
35        $normalizedNumber = '+' . $cleanedNumber;
36    } else {
37        // 例: '+819012345678' (既にE.164形式)
38        // 既に '+' で始まっている場合はそのまま利用します。
39        $normalizedNumber = $cleanedNumber;
40    }
41
42    return $normalizedNumber;
43}
44
45// サンプル使用例:
46echo "Original: 090-1234-5678 => Normalized: " . normalizePhoneNumber("090-1234-5678") . PHP_EOL;
47echo "Original: +81-90-1234-5678 => Normalized: " . normalizePhoneNumber("+81-90-1234-5678") . PHP_EOL;
48echo "Original: (090) 1234-5678 => Normalized: " . normalizePhoneNumber("(090) 1234-5678") . PHP_EOL;
49echo "Original: 001-81-90-1234-5678 => Normalized: " . normalizePhoneNumber("001-81-90-1234-5678") . PHP_EOL;
50echo "Original: 9012345678 (Assuming Japan) => Normalized: " . normalizePhoneNumber("9012345678") . PHP_EOL;
51echo "Original: Invalid input: ABC-DEF => Normalized: " . normalizePhoneNumber("ABC-DEF") . PHP_EOL;
52?>

PHP 8における電話番号の正規化について解説します。このサンプルコードは、国際標準であるE.164形式に電話番号を統一するための関数normalizePhoneNumberを定義しています。

この関数は、$phoneNumberという引数で入力された電話番号を受け取り、$defaultCountryCode（デフォルトは日本の国コード'81'）を参考に正規化処理を行います。まず、ハイフンや括弧などの数字以外の文字をすべて除去し、純粋な数字の並びにします。次に、国際ダイヤルプレフィックス（例: '00'）や国内番号の先頭の'0'の有無に基づいて、適切な国コード（例: '+81'）を付与し、国際形式に変換します。すでに国際形式に近い場合は、そのまま利用されます。

最終的に、正規化された電話番号が文字列として返されます。もし入力された電話番号に数字が含まれていない場合は、空文字列が返されることでエラーや不正な入力を示します。この処理により、様々な形式で入力された電話番号を一貫した形で扱えるようになり、システムでの管理や通信の際に非常に役立ちます。

サンプルコードでは、多様な形式の電話番号がどのように国際標準E.164形式に変換されるか、具体的な例を通じてその動作を確認できます。例えば、「090-1234-5678」は「+819012345678」に、「+81-90-1234-5678」はそのまま「+819012345678」になるなど、関数の柔軟性が示されています。

Copy
1<?php
2
3// CDATASection ノード内のテキストを正規化する例
4$dom = new DOMDocument();
5$dom->loadXML('<root><![CDATA[  Hello   World!  ]]></root>');
6
7// CDATASection ノードを取得
8$cdataSection = $dom->documentElement->firstChild;
9
10// normalize メソッドを呼び出してテキストを正規化
11$cdataSection->normalize();
12
13// 正規化されたテキストを表示
14echo $cdataSection->data . PHP_EOL; // "  Hello   World!  " が出力される (CDATASection では空白は保持される)
15
16// 通常のテキストノードの場合
17$textNode = $dom->createTextNode("  Hello   World!  ");
18$dom->documentElement->appendChild($textNode);
19
20// テキストノードは normalize すると空白が除去される
21$textNode->normalize();
22
23echo $textNode->data . PHP_EOL; // "HelloWorld!" が出力される

PHPのDom\CDATASectionクラスにおけるnormalizeメソッドは、CDATASectionノード内のテキストを正規化するために使用します。このメソッドは引数を取らず、戻り値もありません。

サンプルコードでは、まずDOMDocumentオブジェクトを作成し、XML文字列をロードしています。XMLにはCDATASectionが含まれており、その中には空白を含むテキスト " Hello World! " が格納されています。

次に、$dom->documentElement->firstChildでCDATASectionノードを取得し、normalizeメソッドを呼び出しています。CDATASectionノードの場合、normalizeメソッドを呼び出しても、テキストに含まれる空白は保持されるため、$cdataSection->dataでテキストを表示すると、" Hello World! " がそのまま出力されます。

一方、通常のテキストノードに対してnormalizeメソッドを呼び出すと、テキストの前後の空白が除去され、連続する空白は一つの空白に置き換えられます。サンプルコードでは、テキストノードに対してnormalizeメソッドを呼び出した結果、"HelloWorld!" が出力されることを示しています。

このように、normalizeメソッドの挙動はノードの種類によって異なり、CDATASectionノードでは空白が保持されるのに対し、テキストノードでは空白が除去される点に注意が必要です。このメソッドは、XMLドキュメントを処理する際に、テキストの形式を整えるために役立ちます。

Copy
1<?php
2
3/**
4 * Dom\CDATASection::normalize() メソッドの使用例を示します。
5 *
6 * このメソッドは、DOMText::normalize() を継承しており、通常は隣接するテキストノードを結合するために使用されます。
7 * しかし、XMLの仕様およびPHPのDOM実装において、連続する Dom\CDATASection ノードがこのメソッドによって自動的に結合されることはありません。
8 * メソッドは void を返すため、直接的な戻り値はありません。
9 *
10 * 補足: PHPのDOM拡張は、PHPの標準機能としてほとんどの環境でデフォルトで組み込まれており、
11 * 通常、追加の「インストール」作業は不要です。(キーワード「php normalizer インストール」に関連して)
12 *
13 * @return void
14 */
15function demonstrateCdataSectionNormalize(): void
16{
17    // 新しい DOM ドキュメントを作成
18    $dom = new DOMDocument('1.0', 'UTF-8');
19    $dom->formatOutput = true; // 出力XMLを見やすくするためのオプション
20
21    // ルート要素を作成し、ドキュメントに追加
22    $root = $dom->createElement('root');
23    $dom->appendChild($root);
24
25    // 連続する2つの CDATASection ノードを作成
26    // CDATASection は、特殊文字をエスケープせずにXMLに含めるためのセクションです。
27    $cdata1 = $dom->createCDATASection('これは最初のCDATAの内容です。');
28    $cdata2 = $dom->createCDATASection('これは2番目のCDATAの内容です。');
29
30    // CDATASection ノードをルート要素に追加
31    $root->appendChild($cdata1);
32    $root->appendChild($cdata2);
33
34    echo "--- 正規化前のXML出力 ---" . PHP_EOL;
35    echo $dom->saveXML();
36
37    // Dom\CDATASection::normalize() メソッドを呼び出す
38    // このメソッドは void を返します。
39    // Dom\Text を継承していますが、CDATASection ノードの特性上、
40    // この呼び出しによって隣接する CDATASection ノードが結合されることはありません。
41    $cdata1->normalize();
42
43    echo PHP_EOL . "--- normalize() 呼び出し後のXML出力 ---" . PHP_EOL;
44    echo $dom->saveXML();
45
46    // 参考: 通常、DOMツリー全体のテキストノードを正規化するには DOMDocument::normalize() を使用します。
47    // ただし、これによっても連続する CDATASection ノードは結合されません。
48    // $dom->normalize();
49    // echo PHP_EOL . "--- DOMDocument::normalize() 呼び出し後のXML出力 (参考) ---" . PHP_EOL;
50    // echo $dom->saveXML();
51}
52
53// 関数の実行
54demonstrateCdataSectionNormalize();
55

PHPのDom\CDATASection::normalize()メソッドは、XMLドキュメント内のCDATAセクションを扱うための機能です。このメソッドは引数を必要とせず、直接的な戻り値もありません（void）。通常、親クラスであるDOMText::normalize()メソッドは、隣接するテキストノードを結合して一つにする役割がありますが、Dom\CDATASectionの場合は少し挙動が異なります。

サンプルコードでは、2つの連続するCDATASectionノードを作成し、XMLドキュメントに追加しています。その後で$cdata1->normalize()を呼び出していますが、XMLの仕様とPHPのDOM実装の特性上、このメソッドを呼び出しても隣接するCDATASectionノードが自動的に結合されることはありません。出力結果を見ても、正規化前後でCDATAセクションが別々のノードとして維持されていることが確認できます。

つまり、Dom\CDATASection::normalize()は、CDATASectionノードに対しては目に見える変更を加えないのが一般的です。PHPのDOM拡張は、多くの環境で標準機能として提供されており、「php normalizer インストール」といった追加のインストール作業は通常不要です。