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

Copy
1<?php
2
3/**
4 * 数値を指定された最小桁数で、先頭にゼロを付けてフォーマットします。
5 *
6 * この関数は、日付の月や日、ID番号など、固定桁数で表示したい数値に
7 * 先頭ゼロを付加したい場合に特に役立ちます。
8 * 例えば、5を2桁でフォーマットすると "05" に、7を3桁でフォーマットすると "007" になります。
9 *
10 * @param int $number フォーマットする数値。
11 * @param int $minLength 結果の文字列の最小桁数。この桁数に満たない場合にゼロが埋められます。
12 * @return string 先頭にゼロが付加されたフォーマット済み文字列。
13 */
14function formatNumberWithLeadingZero(int $number, int $minLength = 2): string
15{
16    // sprintf関数を使用して数値をフォーマットします。
17    // '%0' . $minLength . 'd' はフォーマット指定子です。
18    // - '%' はフォーマット指定の開始。
19    // - '0' は埋め文字としてゼロを使用することを意味します。
20    // - $minLength は最終的な文字列の最小桁数。
21    // - 'd' は引数が符号付き10進数（整数）であることを示します。
22    // 例: $minLengthが2の場合、'%02d' となり、5は"05"に、12は"12"になります。
23    // 数値が$minLengthよりも既に長い場合は、そのままの数値が返されます（例: 123を2桁で指定しても"123"）。
24    return sprintf('%0' . $minLength . 'd', $number);
25}
26
27// 以下は、formatNumberWithLeadingZero関数の使用例です。
28// このコードは単体で動作し、関数の振る舞いを示します。
29echo "--- 数値を先頭ゼロでフォーマットする例 ---\n\n";
30
31// 例1: 1桁の数値を2桁にフォーマット
32$value1 = 5;
33$formattedValue1 = formatNumberWithLeadingZero($value1, 2);
34echo "数値: {$value1}, 最小桁数: 2 -> 結果: {$formattedValue1}\n"; // 出力: 05
35
36// 例2: 2桁の数値を2桁にフォーマット
37$value2 = 12;
38$formattedValue2 = formatNumberWithLeadingZero($value2, 2);
39echo "数値: {$value2}, 最小桁数: 2 -> 結果: {$formattedValue2}\n"; // 出力: 12
40
41// 例3: 1桁の数値を3桁にフォーマット
42$value3 = 7;
43$formattedValue3 = formatNumberWithLeadingZero($value3, 3);
44echo "数値: {$value3}, 最小桁数: 3 -> 結果: {$formattedValue3}\n"; // 出力: 007
45
46// 例4: 最小桁数より大きい数値の場合
47$value4 = 123;
48$formattedValue4 = formatNumberWithLeadingZero($value4, 2);
49echo "数値: {$value4}, 最小桁数: 2 -> 結果: {$formattedValue4}\n"; // 出力: 123 (既に桁数が満たされているため変更なし)
50
51// 例5: 0をフォーマット
52$value5 = 0;
53$formattedValue5 = formatNumberWithLeadingZero($value5, 2);
54echo "数値: {$value5}, 最小桁数: 2 -> 結果: {$formattedValue5}\n"; // 出力: 00
55
56?>

このPHPサンプルコードは、数値を指定された最小桁数で、先頭にゼロを付けてフォーマットするformatNumberWithLeadingZero関数を定義しています。この関数は、日付の月や日、ID番号など、固定桁数で数値を表示したい場合に大変役立ちます。

formatNumberWithLeadingZero関数は二つの引数を取ります。一つ目の$numberはフォーマットしたい整数値、二つ目の$minLengthは結果として得られる文字列の最小桁数で、デフォルトは2桁です。この関数は、指定された桁数にゼロが埋められた文字列を戻り値として返します。

内部ではPHPのsprintf関数を利用しており、'%0' . $minLength . 'd'というフォーマット指定子を使っています。これは、「ゼロで埋め（0）、指定された最小桁数（$minLength）の符号付き10進数（d）として数値を表示する」という意味です。例えば、数値5を2桁でフォーマットすると「05」となり、7を3桁でフォーマットすると「007」となります。もし数値が既に指定された最小桁数以上の場合は、そのままの数値が文字列として返されます。サンプルコードには、様々な数値と桁数での使用例が示されており、それぞれの結果がどのように表示されるかを確認できます。

Copy
1<?php
2
3/**
4 * Dom\Element::prefix プロパティの使用例を示します。
5 *
6 * この関数は、名前空間プレフィックスを持つXML要素と持たないXML要素から、
7 * `prefix` プロパティを使ってそれぞれのプレフィックス文字列を取得し表示します。
8 */
9function showElementPrefixExample(): void
10{
11    // 名前空間を持つサンプルXML文字列を定義します。
12    // <book:title> は 'book' というプレフィックスを持っています。
13    // <author> はプレフィックスを持っていません。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<library xmlns:book="http://example.com/books">
17    <book:title>PHP 8 マスターガイド</book:title>
18    <author>PHP 太郎</author>
19</library>
20XML;
21
22    // DOMDocumentオブジェクトを生成し、XMLを読み込みます。
23    // PHP 8からは `Dom` 名前空間の使用が推奨されます。
24    $doc = new Dom\Document();
25    $doc->loadXML($xmlString);
26
27    // 'title' タグを持つ要素を取得します。
28    /** @var Dom\Element $titleElement */
29    $titleElement = $doc->getElementsByTagName('title')->item(0);
30
31    // 'author' タグを持つ要素を取得します。
32    /** @var Dom\Element $authorElement */
33    $authorElement = $doc->getElementsByTagName('author')->item(0);
34
35    // --- プレフィックスを持つ要素の確認 ---
36    echo "要素名 (tagName): " . $titleElement->tagName . PHP_EOL;
37    // `prefix` プロパティで名前空間プレフィックス ('book') を取得できます。
38    echo "プレフィックス (prefix): " . $titleElement->prefix . PHP_EOL;
39    echo PHP_EOL;
40
41    // --- プレフィックスを持たない要素の確認 ---
42    echo "要素名 (tagName): " . $authorElement->tagName . PHP_EOL;
43    // プレフィックスがない場合、`prefix` プロパティは空の文字列を返します。
44    echo "プレフィックス (prefix): '" . $authorElement->prefix . "'" . PHP_EOL;
45}
46
47// 関数を実行して結果を表示します。
48showElementPrefixExample();
49

PHPのDom\Element::prefixは、XML要素の名前空間プレフィックスを取得するためのプロパティです。このプロパティは引数を取らず、戻り値としてプレフィックス名を表す文字列（string）を返します。

サンプルコードでは、まずxmlns:bookという名前空間が定義されたXML文書を読み込んでいます。ここに含まれる<book:title>という要素は、bookという名前空間プレフィックスを持っています。この要素オブジェクトからprefixプロパティにアクセスすると、その値として文字列'book'が取得できます。

一方、同じXML文書内の<author>要素には名前空間プレフィックスがありません。そのため、この要素オブジェクトのprefixプロパティを取得すると、空の文字列''が返されます。

このようにDom\Element::prefixプロパティを利用することで、XML文書を解析する際に、各要素がどの名前空間に属しているかを簡単に識別でき、名前空間に応じた処理を行う場合に役立ちます。