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

Copy
1<?php
2
3/**
4 * このコードは、PHPの Dom\ProcessingInstruction::normalize() メソッドの使用例と、
5 * 「電話番号の正規化」という一般的なタスクのサンプルを示します。
6 *
7 * Dom\ProcessingInstruction::normalize() はDOMツリー内のノードを正規化するためのメソッドで、
8 * 具体的には隣接するテキストノードを結合したり、空のテキストノードを削除したりします。
9 * ProcessingInstructionノードは通常、子ノードを持たないため、このメソッドを直接呼び出しても
10 * そのノード自体に目に見える変化はほとんどありませんが、親ノードの正規化プロセスの一部として機能します。
11 *
12 * 一方、「電話番号の正規化」は、電話番号の文字列からハイフンやスペースなどの不要な文字を除去し、
13 * 数字のみの統一された形式に変換する一般的な文字列処理です。
14 */
15
16// --- Dom\ProcessingInstruction::normalize() のデモンストレーション ---
17
18echo "--- DOM ProcessingInstruction::normalize() の例 --- \n";
19
20// 新しいDOMDocumentを作成
21$dom = new DOMDocument('1.0', 'UTF-8');
22$dom->formatOutput = true; // 出力を整形して見やすくする
23
24// ルート要素を追加
25$root = $dom->createElement('data');
26$dom->appendChild($root);
27
28// ProcessingInstructionノードを作成
29// 例えば、XMLスタイルシートへのリンクを示す処理命令
30$pi = $dom->createProcessingInstruction('xml-stylesheet', 'type="text/css" href="style.css"');
31
32// ProcessingInstructionをDOMツリーに追加
33// ここではルート要素の直前に挿入
34$dom->insertBefore($pi, $root);
35
36// Dom\ProcessingInstruction::normalize() メソッドを呼び出す
37// このメソッドは引数なしで void を返します。
38// ProcessingInstructionノードは通常子ノードを持たないため、
39// この呼び出しによる直接的な視覚的効果は期待できませんが、
40// DOMの正規化プロセスの一部としてメソッドが実行されます。
41$pi->normalize();
42
43echo "XML ドキュメントの出力:\n";
44echo $dom->saveXML();
45echo "\n";
46
47// --- 電話番号の正規化の一般的な例 ---
48
49/**
50 * 電話番号文字列を一般的な形式（数字のみ）に正規化します。
51 * ハイフン、スペース、括弧などの不要な記号を除去します。
52 *
53 * @param string $phoneNumber 正規化する電話番号文字列。
54 * @return string 数字のみで構成された正規化済みの電話番号文字列。
55 */
56function normalizePhoneNumber(string $phoneNumber): string
57{
58    // preg_replace関数を使用して、数字以外のすべての文字を除去します。
59    // '/[^0-9]/' は「数字（0-9）以外」の文字にマッチする正規表現です。
60    // 第2引数の '' は、マッチした文字を空文字列で置き換えることを意味します。
61    $normalizedNumber = preg_replace('/[^0-9]/', '', $phoneNumber);
62
63    // 必要に応じて、国コードの追加や特定の長さへの調整など、
64    // より複雑な正規化ロジックをここに追加できます。
65    // 例: 日本の電話番号で「0」から始まる場合、「+81」に変換する
66    // if (substr($normalizedNumber, 0, 1) === '0' && strlen($normalizedNumber) > 1) {
67    //     $normalizedNumber = '+81' . substr($normalizedNumber, 1);
68    // }
69
70    return $normalizedNumber;
71}
72
73echo "--- 電話番号の正規化の例 --- \n";
74
75$rawPhoneNumber1 = "090-1234-5678";
76$normalizedPhoneNumber1 = normalizePhoneNumber($rawPhoneNumber1);
77echo "元の電話番号: " . $rawPhoneNumber1 . "\n";
78echo "正規化された電話番号: " . $normalizedPhoneNumber1 . "\n\n";
79
80$rawPhoneNumber2 = "+81 (0) 90 9876 5432";
81$normalizedPhoneNumber2 = normalizePhoneNumber($rawPhoneNumber2);
82echo "元の電話番号: " . $rawPhoneNumber2 . "\n";
83echo "正規化された電話番号: " . $normalizedPhoneNumber2 . "\n\n";
84
85$rawPhoneNumber3 = "03 1234 5678 (代表)";
86$normalizedPhoneNumber3 = normalizePhoneNumber($rawPhoneNumber3);
87echo "元の電話番号: " . $rawPhoneNumber3 . "\n";
88echo "正規化された電話番号: " . $normalizedPhoneNumber3 . "\n";
89
90?>

このPHPサンプルコードは、主に二つの「正規化（normalize）」の概念を説明しています。一つはPHPのDOM拡張機能におけるDom\ProcessingInstruction::normalize()メソッド、もう一つは文字列処理における一般的な「電話番号の正規化」です。

Dom\ProcessingInstruction::normalize()メソッドは、DOMツリー内のノード構造を整頓するためのものです。具体的には、隣接するテキストノードを結合したり、空のテキストノードを削除したりすることで、DOMツリーを標準的な状態に保ちます。このメソッドは引数を持たず、戻り値もありません（void）。サンプルコードではDOMDocumentにProcessingInstructionノードを追加し、そのノードに対してnormalize()を呼び出す例を示しています。ProcessingInstructionノード自体は通常子ノードを持たないため、この呼び出しによるノード自身への直接的な視覚的変化はほとんどありませんが、DOM全体の正規化プロセスの一部として機能します。

一方、コードの後半で示される「電話番号の正規化」は、電話番号の文字列に含まれるハイフン、スペース、括弧などの不要な記号を除去し、数字のみの統一された形式に変換する一般的なデータ処理です。この処理はpreg_replace()関数を使用し、数字以外の文字にマッチする正規表現'/[^0-9]/'を空文字列に置き換えることで実現しています。これにより、ユーザーが様々な形式で入力した電話番号データを、システムで扱いやすい単一の形式に統一することが可能になります。両者の「正規化」は異なる文脈で使われますが、データを整え、扱いやすくするという共通の目的を持っています。

Copy
1<?php
2
3/**
4 * Dom\ProcessingInstructionを含むDOMツリーでnormalize()メソッドの効果を確認するサンプルコード
5 *
6 * `normalize()` メソッドは、指定されたノードとそのサブツリー全体を正規化します。
7 * 具体的には、隣接するテキストノードを1つのノードにマージし、
8 * 空のテキストノードを削除します。
9 * このメソッドは `Dom\Node` クラスから継承されるため、
10 * `Dom\ProcessingInstruction` を含む多くのDOMノードで利用可能です。
11 */
12function demonstrateDomNormalization(): void
13{
14    // 1. DOMDocumentオブジェクトを作成
15    $dom = new DOMDocument('1.0', 'UTF-8');
16    // 出力されるXMLを見やすくフォーマットする
17    $dom->formatOutput = true;
18
19    // 2. ルート要素 <root> を作成し、ドキュメントに追加
20    $root = $dom->createElement('root');
21    $dom->appendChild($root);
22
23    // 3. 処理命令 (Processing Instruction) ノードを作成し、ルート要素に追加
24    // これは <?php-formatter-ignore?> のようなノードになります
25    $pi = $dom->createProcessingInstruction('php-formatter', 'ignore');
26    $root->appendChild($pi);
27
28    // 4. 複数の隣接するテキストノードを持つ <content> 要素を作成
29    // これらは normalize() によって結合される対象です
30    $content = $dom->createElement('content');
31    $content->appendChild($dom->createTextNode('隣接テキスト１'));
32    $content->appendChild($dom->createTextNode('と'));
33    $content->appendChild($dom->createTextNode('隣接テキスト２'));
34    $root->appendChild($content);
35
36    // 5. 正規化前のXMLを出力
37    echo "--- normalize() 実行前 ---" . PHP_EOL;
38    echo $dom->saveXML();
39    echo PHP_EOL;
40
41    // 6. ルート要素に対して normalize() を実行
42    // これにより、<content> 要素内の3つのテキストノードが1つにマージされます
43    $dom->documentElement->normalize();
44
45    // 7. 正規化後のXMLを出力
46    echo "--- normalize() 実行後 ---" . PHP_EOL;
47    echo $dom->saveXML();
48}
49
50demonstrateDomNormalization();

このPHPサンプルコードは、XMLのDOMツリー構造を整理する normalize() メソッドの動作を実演するものです。normalize() は、指定したノードとその全ての子孫ノードを正規化します。主な役割は、隣接して存在する複数のテキストノードを一つのテキストノードに結合し、空のテキストノードを削除することです。これにより、XMLの構造がより簡潔で扱いやすくなります。

コードでは、まず<root>要素、処理命令ノード <?php-formatter ignore?>、そして<content>要素を持つDOMドキュメントを構築します。<content>要素内には、「隣接テキスト１」「と」「隣接テキスト２」という3つの別々のテキストノードを意図的に配置しています。

最初にnormalize()を呼び出す前のXMLを出力し、テキストノードが分割されている状態を確認します。次に、ドキュメントのルート要素に対してnormalize()メソッドを実行します。このメソッドは引数を取らず、戻り値もありません（void）。呼び出したノードの状態を直接変更します。実行後、再度XMLを出力すると、3つに分かれていたテキストノードが「隣接テキスト１と隣接テキスト２」という一つのノードに統合されていることがわかります。

このnormalize()メソッドは、Dom\ProcessingInstructionクラスが親クラスのDom\Nodeから継承している機能のため、要素ノードなど他の多くのDOMノードでも同様に利用できます。

Copy
1<?php
2
3/**
4 * Dom\ProcessingInstruction::normalize() メソッドの使用例。
5 *
6 * このメソッドはDOM拡張機能の一部であり、通常PHPに標準で含まれているため、
7 * 通常のPHP環境では追加の「normalizer」パッケージのインストールは不要です。
8 * ProcessingInstructionノード自体には子ノードがないため、
9 * normalize()を呼び出しても通常は目に見える変更はありません。
10 */
11function demonstrateProcessingInstructionNormalize(): void
12{
13    // 新しいDOMDocumentを作成します。
14    $dom = new DOMDocument('1.0', 'UTF-8');
15    $dom->formatOutput = true; // 出力を見やすく整形します。
16
17    // 処理命令 (Processing Instruction) ノードを作成します。
18    $target = 'php-instruction';
19    $data = 'version="8.0" encoding="utf-8"';
20    $pi = $dom->createProcessingInstruction($target, $data);
21
22    // ドキュメントに処理命令を追加します。
23    $dom->appendChild($pi);
24
25    // ルート要素を作成し、追加します。(処理命令の後に続く要素として)
26    $root = $dom->createElement('root');
27    $dom->appendChild($root);
28
29    echo "--- normalize() 呼び出し前 ---\n";
30    echo $dom->saveXML();
31
32    // Dom\ProcessingInstruction::normalize() を呼び出します。
33    // このメソッドはvoidを返し、ProcessingInstructionノード自体には
34    // 通常、視覚的な変更をもたらしません。
35    $pi->normalize();
36
37    echo "\n--- normalize() 呼び出し後 ---\n";
38    echo $dom->saveXML();
39}
40
41// サンプルコードを実行します。
42demonstrateProcessingInstructionNormalize();
43

このサンプルコードは、PHPのDOM拡張機能に含まれるDom\ProcessingInstruction::normalize()メソッドの利用例を示しています。Dom\ProcessingInstructionは、XMLやHTMLドキュメント内で処理命令（<?target data?>のような形式）を表すノードです。

normalize()メソッドは引数を取らず、戻り値もありません（void）。一般的にDOMツリー全体に対して呼び出された場合、隣接するテキストノードを結合したり、空のテキストノードを削除したりして、DOMツリーを整理する役割があります。しかし、Dom\ProcessingInstructionノード自体は子ノードを持たないため、このメソッドを個別に呼び出しても、ノードの内容や構造に目に見える変更は通常発生しません。

本メソッドはPHPに標準で含まれるDOM拡張機能の一部として提供されており、提供されたキーワード「php normalizer インストール」が示すような追加の「normalizer」パッケージのインストールは不要です。これは、Unicode正規化を行う別のNormalizerクラスとは異なりますのでご注意ください。

サンプルコードでは、まず新しいDOMDocumentを作成し、php-instructionというターゲットとデータを持つ処理命令ノードを作成・追加しています。その後、normalize()メソッドを呼び出す前後でXML出力を比較していますが、処理命令ノードに対する正規化は視覚的な変化をもたらさないことが確認できます。これは、ProcessingInstructionノードが正規化の対象となる子ノードを持たないためです。