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

Copy
1<?php
2
3/**
4 * 指定された桁数になるように、数値の前に '0' を付けてフォーマットします。
5 * これは一般的に「ゼロパディング」と呼ばれます。
6 *
7 * @param int $number パディング対象の数値。
8 * @param int $digits フォーマット後の全体の桁数。
9 * @return string '0'で先頭が埋められた数値文字列。
10 */
11function prefixNumberWithZeros(int $number, int $digits): string
12{
13    // sprintf関数は、指定されたフォーマットに従って文字列を生成します。
14    // "%0{$digits}d" のフォーマット指定の意味:
15    // % : フォーマット指定の開始
16    // 0 : 足りない桁を空白ではなく '0' で埋める
17    // {$digits} : 全体の桁数を変数 $digits の値で指定する
18    // d : 引数を10進数の整数として扱う
19    return sprintf("%0{$digits}d", $number);
20}
21
22// --- 関数の使用例 ---
23
24// 数値 7 を 4桁 になるように '0' を付けます。
25$number1 = 7;
26$totalDigits1 = 4;
27$result1 = prefixNumberWithZeros($number1, $totalDigits1);
28echo "数値 {$number1} を {$totalDigits1} 桁にフォーマット: {$result1}" . PHP_EOL; // 出力: 数値 7 を 4 桁にフォーマット: 0007
29
30// 数値 123 を 5桁 になるように '0' を付けます。
31$number2 = 123;
32$totalDigits2 = 5;
33$result2 = prefixNumberWithZeros($number2, $totalDigits2);
34echo "数値 {$number2} を {$totalDigits2} 桁にフォーマット: {$result2}" . PHP_EOL; // 出力: 数値 123 を 5 桁にフォーマット: 00123
35
36// 元の数値が指定桁数以上の場合、何も付け加えられません。
37$number3 = 98765;
38$totalDigits3 = 3;
39$result3 = prefixNumberWithZeros($number3, $totalDigits3);
40echo "数値 {$number3} を {$totalDigits3} 桁にフォーマット: {$result3}" . PHP_EOL; // 出力: 数値 98765 を 3 桁にフォーマット: 98765
41

このPHPサンプルコードは、数値の先頭に「0」を追加して、指定された桁数に揃える「ゼロパディング」という処理を行う関数を定義したものです。

prefixNumberWithZeros関数は2つの引数を受け取ります。第1引数の$numberには対象となる数値を、第2引数の$digitsには最終的に揃えたい全体の桁数を指定します。この関数の戻り値は、桁数が揃えられた後の文字列です。

関数の中核を担っているのは、PHPに標準で用意されているsprintf関数です。この関数は、与えられた書式指定に従って文字列を生成します。コード中の"%0{$digits}d"という書式は、「引数で受け取った数値を10進数の整数として扱い、全体の桁数が$digitsの値に満たない場合は、足りない部分を先頭から文字の『0』で埋める」という指示を表しています。

使用例のように、数値7と桁数4を渡すと、"0007"という文字列が返されます。一方で、元の数値98765が指定した桁数3を既に超えている場合は、先頭に0は追加されず、"98765"という文字列がそのまま返されます。

Copy
1<?php
2
3declare(strict_types=1);
4
5// 名前空間を持つ属性と持たない属性を含むXML文字列を準備します。
6// <product>要素には、プレフィックス 'ns1' を持つ 'ns1:category' 属性と、
7// プレフィックスを持たない 'code' 属性があります。
8$xmlString = <<<XML
9<?xml version="1.0" encoding="UTF-8"?>
10<products xmlns:ns1="http://www.example.com/schema1">
11  <product ns1:category="books" code="PHP-001">
12    <name>Modern PHP</name>
13  </product>
14</products>
15XML;
16
17// DOMDocumentオブジェクトを生成し、XML文字列を読み込みます。
18$dom = new DOMDocument();
19$dom->loadXML($xmlString);
20
21// 'product' という名前のタグを持つ最初の要素ノードを取得します。
22$productElement = $dom->getElementsByTagName('product')->item(0);
23
24// 要素が持つ属性を一つずつ処理します。
25// $productElement->attributes は属性ノード(DOMAttr)のコレクションです。
26/** @var DOMAttr $attribute */
27foreach ($productElement->attributes as $attribute) {
28    // DOMAttr::prefix プロパティで属性の名前空間プレフィックスを取得します。
29    // プレフィックスが存在する場合、その文字列を返します (例: 'ns1')。
30    // プレフィックスが存在しない場合、null を返します。
31    $prefix = $attribute->prefix;
32
33    // 属性名と取得したプレフィックスの型と値を表示します。
34    echo '属性 [' . $attribute->nodeName . '] のプレフィックス: ';
35    var_dump($prefix);
36}
37
38/*
39--- 実行結果 ---
40属性 [ns1:category] のプレフィックス: string(3) "ns1"
41属性 [code] のプレフィックス: NULL
42*/
43

DOMAttr::prefixは、XMLやHTMLの属性が持つ名前空間プレフィックスを取得するためのプロパティです。このプロパティは値を取得するだけなので、引数は必要ありません。

サンプルコードでは、まず名前空間プレフィックスns1:を持つ属性ns1:categoryと、プレフィックスを持たない属性codeを含んだXML文字列を準備します。次に、DOMDocumentクラスを使ってこのXMLを解析し、<product>要素を取得しています。

foreachループでは、取得した要素が持つ各属性（DOMAttrオブジェクト）を順番に処理します。ループの中で$attribute->prefixと記述することで、その属性の名前空間プレフィックスにアクセスできます。

このプロパティの戻り値は、属性にプレフィックスが存在する場合はその名前の文字列（string）となり、存在しない場合はnullになります。実行結果では、ns1:category属性のプレフィックスとして文字列"ns1"が取得され、プレフィックスのないcode属性ではNULLが返されていることが確認できます。このように、属性に特定の名前空間が関連付けられているかを判別する際に役立ちます。