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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定された桁数になるように、数値の前にゼロを追加（ゼロパディング）します。
7 *
8 * この関数は、数値を文字列に変換し、指定された桁数に満たない場合に
9 * 左側を '0' で埋めます。例えば、数値 12 を 4 桁で表現したい場合、
10 * '0012' という文字列を返します。
11 *
12 * @param int $number パディングする整数。
13 * @param int $totalDigits 結果として得たい文字列の総桁数。
14 * @return string ゼロでパディングされた数値の文字列。
15 */
16function prefixNumberWithZero(int $number, int $totalDigits): string
17{
18    // sprintf関数は、指定されたフォーマットに従って文字列を生成します。
19    // "%0{$totalDigits}d" というフォーマットは、次のような意味を持ちます。
20    // - %: フォーマット指定子の開始
21    // - 0: パディングに使う文字（この場合はゼロ）
22    // - {$totalDigits}: 全体の桁数（変数を展開して指定）
23    // - d: 引数を10進数の整数として扱う
24    return sprintf("%0{$totalDigits}d", $number);
25}
26
27// --- 関数の使用例 ---
28
29// 数値 5 を4桁の文字列 '0005' に変換します。
30$number1 = 5;
31$paddedNumber1 = prefixNumberWithZero($number1, 4);
32echo "{$number1} -> {$paddedNumber1}" . PHP_EOL;
33
34// 数値 123 を4桁の文字列 '0123' に変換します。
35$number2 = 123;
36$paddedNumber2 = prefixNumberWithZero($number2, 4);
37echo "{$number2} -> {$paddedNumber2}" . PHP_EOL;
38
39// 数値 4567 は既に4桁なので、文字列 '4567' のままです。
40$number3 = 4567;
41$paddedNumber3 = prefixNumberWithZero($number3, 4);
42echo "{$number3} -> {$paddedNumber3}" . PHP_EOL;
43
44// 数値 89123 は指定した4桁を超えているため、パディングされず '89123' のままです。
45$number4 = 89123;
46$paddedNumber4 = prefixNumberWithZero($number4, 4);
47echo "{$number4} -> {$paddedNumber4}" . PHP_EOL;
48
49?>

このPHPサンプルコードは、数値を指定した桁数に揃えるため、先頭に必要な数のゼロを追加する「ゼロパディング」という処理を実装したものです。

コード内の prefixNumberWithZero 関数がこの処理の中心です。この関数は2つの引数を取ります。第1引数の $number には処理対象となる整数を、第2引数の $totalDigits には最終的に何桁の文字列にしたいかを指定します。戻り値として、ゼロが追加された結果の文字列を返します。

関数の内部では、指定された書式で文字列を生成する sprintf 関数が利用されています。この関数に "%0[桁数]d" のような書式を渡すことで、指定した桁数に満たない場合に自動的に先頭をゼロで埋めることができます。

サンプルコードの実行例のように、数値 5 を 4 桁で指定すると '0005' という文字列が生成されます。一方、元の数値が指定した桁数と同じかそれ以上の場合は、ゼロは追加されず、数値がそのまま文字列に変換されて返されます。この方法は、連番のファイル名や管理番号など、桁数を固定してデータを扱いたい場面で役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * DOM要素の名前空間プレフィックス（prefix）を取得するサンプルコード
7 *
8 * DOMDocumentを使ってXMLを解析し、特定の要素ノードの `prefix` プロパティに
9 * アクセスして、そのノードの名前空間プレフィックス（文字列）を取得します。
10 */
11function demonstrateDomElementPrefix(): void
12{
13    // 名前空間プレフィックス 'dc' を持つXML文字列を準備します。
14    $xmlString = <<<XML
15<?xml version="1.0" encoding="UTF-8"?>
16<book xmlns:dc="http://purl.org/dc/elements/1.1/">
17  <title>PHP入門</title>
18  <dc:creator>Taro Yamada</dc:creator>
19</book>
20XML;
21
22    // DOMDocumentのインスタンスを生成します。
23    $dom = new DOMDocument();
24
25    // XML文字列を読み込みます。
26    $dom->loadXML($xmlString);
27
28    // 'creator' というローカル名を持つ要素ノードを取得します。
29    // getElementsByTagNameはプレフィックスを無視してタグ名で検索します。
30    $creatorNode = $dom->getElementsByTagName('creator')->item(0);
31
32    // 要素ノードの prefix プロパティを取得します。
33    // <dc:creator> のプレフィックスである 'dc' という文字列が返されます。
34    if ($creatorNode) {
35        $prefixString = $creatorNode->prefix;
36        echo "ノード名: " . $creatorNode->nodeName . PHP_EOL;
37        echo "プレフィックス: " . $prefixString . PHP_EOL;
38    }
39
40    // 参考: ドキュメント要素 (<book>) にはプレフィックスがないため、空文字列が返ります。
41    $documentElement = $dom->documentElement;
42    if ($documentElement) {
43        $docPrefix = $documentElement->prefix ?? '（なし）'; // PHP 8.0 null合体演算子
44        echo "ドキュメント要素のプレフィックス: " . ($docPrefix ?: '（なし）') . PHP_EOL;
45    }
46}
47
48// 関数を実行して結果を表示します。
49demonstrateDomElementPrefix();

prefixプロパティは、XMLやHTMLの要素ノードが持つ名前空間プレフィックスを取得するためのものです。このプロパティに引数はなく、戻り値としてプレフィックスを表す文字列（string）を返します。

このサンプルコードでは、まずdcという名前空間プレフィックスを持つXMLデータ（<dc:creator>）を文字列として準備します。次に、PHPのDOMDocumentクラスを使ってこのXMLデータを解析し、プログラムで扱えるオブジェクト構造に変換します。そして、getElementsByTagNameメソッドでcreator要素を取得します。

取得した要素オブジェクトのprefixプロパティにアクセスすると、その要素のプレフィックスが文字列として取得できます。この例では、<dc:creator>要素から'dc'という文字列が返されます。一方、<book>要素のようにプレフィックスが定義されていない要素の場合、このプロパティはnullを返します。このようにprefixプロパティを利用することで、XML文書内の各要素がどの名前空間に属しているかを、そのプレフィックスから簡単に識別することができます。