【PHP8.x】DOMEntityReference::prefixプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された桁数になるように、数値の前に'0'を付けて返す（ゼロパディング）。
7 *
8 * この関数は、数値を文字列に変換し、指定された全体の長さになるまで
9 * 左側を '0' で埋めます。元の数値の桁数が指定した長さを超える場合、
10 * 何も付け加えられずにそのままの文字列が返されます。
11 *
12 * @param int $number パディング対象の数値
13 * @param int $length 結果の文字列の全体の長さ
14 * @return string ゼロでパディングされた数値文字列
15 */
16function prefixNumberWithZeros(int $number, int $length): string
17{
18    // str_pad()関数を使い、数値を文字列に変換してから左側を'0'で埋める
19    // 第1引数: 対象の文字列
20    // 第2引数: 結果の文字列の長さ
21    // 第3引数: 埋める文字
22    // 第4引数: 埋める方向 (STR_PAD_LEFTは左側)
23    return str_pad((string)$number, $length, '0', STR_PAD_LEFT);
24}
25
26// --- サンプルコードの実行例 ---
27
28// 数値 7 を 3桁の文字列 '007' にする
29$paddedNumber1 = prefixNumberWithZeros(7, 3);
30echo $paddedNumber1 . PHP_EOL; // 出力: 007
31
32// 数値 123 を 5桁の文字列 '00123' にする
33$paddedNumber2 = prefixNumberWithZeros(123, 5);
34echo $paddedNumber2 . PHP_EOL; // 出力: 00123
35
36// 数値 9876 が既に指定桁数 4 と同じなので、そのまま '9876' になる
37$paddedNumber3 = prefixNumberWithZeros(9876, 4);
38echo $paddedNumber3 . PHP_EOL; // 出力: 9876
39
40?>

このPHPコードは、数値の前に'0'を追加して、指定した桁数に揃える「ゼロパディング」という処理を実装したサンプルです。この処理は、ファイル名やID番号などで桁数を統一したい場合によく利用されます。

サンプルでは、prefixNumberWithZerosという関数が定義されています。この関数は2つの引数を受け取ります。第1引数の$numberには、ゼロパディングの対象となる数値を指定します。第2引数の$lengthには、最終的に何桁の文字列にしたいかを指定します。

関数の内部では、PHPに標準で用意されているstr_pad()関数が使われています。この関数は、まず引数で受け取った数値を文字列に変換します。その後、文字列全体の長さが第2引数で指定した$lengthに達するまで、左側を'0'で埋めていきます。

処理が完了すると、戻り値として'0'で桁数が調整された文字列が返されます。例えば、prefixNumberWithZeros(7, 3)と呼び出すと、7が3桁になるように左側に'0'が2つ追加され、文字列の'007'が得られます。もし、元の数値の桁数が指定した長さ以上の場合、'0'は追加されずにそのままの数値が文字列として返されます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOMEntityReferenceのprefixプロパティの使用例を示します。
7 *
8 * この関数は、名前空間プレフィックスを持つエンティティ参照と、
9 * 持たないエンティティ参照を作成し、それぞれのprefixプロパティの値を表示します。
10 */
11function demonstrateDomEntityReferencePrefix(): void
12{
13    // DOMDocumentオブジェクトのインスタンスを生成します
14    $dom = new DOMDocument();
15
16    // 1. 名前空間プレフィックスを持つエンティティ参照ノードを作成します
17    // エンティティ参照の名前が "ns:example" の場合
18    $entityRefWithPrefix = $dom->createEntityReference('ns:example');
19
20    // prefixプロパティは、ノードの名前空間プレフィックス（この場合は 'ns'）を文字列として返します
21    echo 'Prefix for "&ns:example;": ';
22    var_dump($entityRefWithPrefix->prefix);
23
24    echo PHP_EOL;
25
26    // 2. 名前空間プレフィックスを持たないエンティティ参照ノードを作成します
27    // エンティティ参照の名前が "simple" の場合
28    $entityRefWithoutPrefix = $dom->createEntityReference('simple');
29
30    // プレフィックスが存在しない場合、prefixプロパティは null を返します
31    echo 'Prefix for "&simple;": ';
32    var_dump($entityRefWithoutPrefix->prefix);
33}
34
35// 関数を実行して結果を表示します
36demonstrateDomEntityReferencePrefix();
37
38?>

PHPのDOMEntityReferenceクラスに属するprefixプロパティは、XML文書内におけるエンティティ参照ノードの名前空間プレフィックスを取得するためのものです。このプロパティは読み取り専用であり、引数はありません。

サンプルコードでは、まずDOMDocumentオブジェクトを生成し、createEntityReferenceメソッドを使って2種類のエンティティ参照ノードを作成しています。

一つ目は'ns:example'という名前のノードです。この名前にはコロン:で区切られた前半部分'ns'があり、これが名前空間プレフィックスとして扱われます。このノードのprefixプロパティにアクセスすると、プレフィックスである文字列'ns'が返されます。

二つ目は'simple'という名前のノードで、こちらには名前空間プレフィックスが含まれていません。そのため、このノードのprefixプロパティの値はnullとなります。

このように、prefixプロパティの戻り値は、名前空間プレフィックスが存在すればその文字列（string）、存在しなければnullとなり、XMLノードの名前空間を判別する際に役立ちます。