【PHP8.x】renameメソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルシステムのrename()とDom\Attr::rename()の違いを示すサンプルクラス。
7 *
8 * キーワード「php rename パーミッション」は、通常、ファイルやディレクトリの名前を
9 * 変更する組み込み関数 rename() に関するものです。この関数は、対象への
10 * 書き込みパーミッション（権限）がない場合に失敗します。
11 *
12 * 一方、指定されたリファレンス情報 `Dom\Attr::rename()` は、メモリ上の
13 * XML/HTMLドキュメントオブジェクトモデル（DOM）の属性名を変更するメソッドです。
14 * これはファイルシステムを直接操作しないため、パーミッションの問題は発生しません。
15 *
16 * このサンプルコードでは、あえてファイルを作成し、そのファイル名を変更しようとして
17 * 失敗するシナリオ（rename() とパーミッション）と、XML文字列の属性名を
18 * 変更する成功シナリオ（Dom\Attr::rename()）の両方を示します。
19 */
20class RenameExample
21{
22    /**
23     * ファイル名を変更しようとして、パーミッションエラーを意図的に発生させる
24     *
25     * @param string $dir 作業ディレクトリ
26     * @return void
27     */
28    public function demonstrateFileSystemRename(string $dir): void
29    {
30        echo "--- ファイルシステムの rename() の試行（パーミッションエラー） ---\n";
31
32        // 実行ユーザーが書き込めないディレクトリとファイルを作成
33        $targetDir = $dir . '/no_permission_dir';
34        $originalFile = $targetDir . '/original.txt';
35        $renamedFile = $targetDir . '/renamed.txt';
36
37        // ディレクトリを読み取り専用(0555)で作成
38        if (!is_dir($targetDir)) {
39            mkdir($targetDir, 0555, true);
40        }
41        file_put_contents($originalFile, 'test data');
42        // ファイル自体も読み取り専用にする
43        chmod($originalFile, 0444);
44
45        echo "{$originalFile} の名前を {$renamedFile} に変更しようとします...\n";
46
47        // rename() は書き込み権限がないため失敗し、E_WARNING が発生する
48        // @でエラー出力を抑制し、戻り値で成否を判断
49        if (@rename($originalFile, $renamedFile)) {
50            echo "ファイル名の変更に成功しました。（このメッセージは表示されないはずです）\n";
51        } else {
52            $error = error_get_last();
53            echo "ファイル名の変更に失敗しました。\n";
54            echo "原因: おそらくディレクトリの書き込みパーミッションがありません。\n";
55            echo "PHP Warning: " . ($error['message'] ?? 'Unknown error') . "\n";
56        }
57
58        // 後片付け
59        chmod($originalFile, 0644); // 削除できるように権限を戻す
60        chmod($targetDir, 0755);
61        unlink($originalFile);
62        rmdir($targetDir);
63
64        echo "\n";
65    }
66
67    /**
68     * Dom\Attr::rename() を使用してXMLの属性名を変更する
69     *
70     * @return void
71     */
72    public function demonstrateDomAttrRename(): void
73    {
74        echo "--- Dom\\Attr::rename() の実行（ファイルI/Oなし） ---\n";
75
76        $xmlString = '<item old_id="A-123">Sample Item</item>';
77        echo "変更前のXML: " . htmlspecialchars($xmlString) . "\n";
78
79        $dom = new DOMDocument();
80        $dom->loadXML($xmlString);
81
82        // 属性ノードを取得
83        $element = $dom->getElementsByTagName('item')->item(0);
84        $attribute = $element->getAttributeNode('old_id');
85
86        // メモリ上で属性名を変更 (ファイルシステムは無関係)
87        $attribute->rename(null, 'new_id');
88
89        $newXmlString = $dom->saveXML($dom->documentElement);
90        echo "変更後のXML: " . htmlspecialchars($newXmlString) . "\n";
91        echo "Dom\\Attr::rename() はメモリ上の操作のため、パーミッションとは無関係に成功します。\n";
92    }
93}
94
95// --- 実行コード ---
96$example = new RenameExample();
97
98// /tmp ディレクトリなど、一般的に書き込み可能な場所を指定
99$workDir = sys_get_temp_dir();
100
101$example->demonstrateFileSystemRename($workDir);
102$example->demonstrateDomAttrRename();

Dom\Attr::rename()は、メモリ上にあるXMLやHTMLのDOM（ドキュメントオブジェクトモデル）ドキュメント内にある、特定の属性の名前を変更するためのメソッドです。これはファイル名を変更するPHPの組み込み関数rename()とは異なり、ファイルシステムを直接操作しないため、ファイルのパーミッション（書き込み権限）とは無関係に動作します。

サンプルコードでは、まず<item old_id="A-123">というXML文字列をDOMDocumentオブジェクトとして読み込みます。そしてitem要素からold_idという名前の属性ノードを取得し、そのrename()メソッドを呼び出しています。

メソッドの第1引数$namespaceURIにはXMLの名前空間URIを指定します。この例では名前空間がないためnullを渡しています。第2引数$qualifiedNameには新しい属性名である'new_id'を文字列で指定しています。この結果、属性名はold_idからnew_idへと変更され、最終的にXMLは<item new_id="A-123">という形式で出力されます。戻り値は処理が成功した場合はtrue、失敗した場合はfalseを返します。

Copy
1<?php
2
3/**
4 * Dom\Attr::rename() の成功例と、失敗する原因を示す例を実演します。
5 *
6 * 属性のリネームは、XMLの命名規則に違反する名前（例: スペースを含む、数字で始まる）を
7 * 新しい属性名として指定した場合に DOMException をスローして失敗します。
8 * このサンプルでは、その具体的な挙動を確認します。
9 */
10function demonstrateAttrRenameFailure(): void
11{
12    // 1. DOMDocumentオブジェクトを準備
13    $dom = new DOMDocument('1.0', 'UTF-8');
14    // 出力されるXMLを見やすくフォーマットする
15    $dom->formatOutput = true;
16
17    // 2. <book original_id="A-001"></book> という要素と属性を作成
18    $element = $dom->createElement('book');
19    $dom->appendChild($element);
20
21    $attribute = $dom->createAttribute('original_id');
22    $attribute->value = 'A-001';
23    $element->setAttributeNode($attribute);
24
25    echo "--- 初期状態のXML ---" . PHP_EOL;
26    echo $dom->saveXML();
27    echo PHP_EOL;
28
29    // 3. 成功するリネームの例
30    // 'original_id' を 'new_id' という有効な名前に変更します
31    echo "--- 成功例: 'original_id' を 'new_id' にリネーム ---" . PHP_EOL;
32    if ($attribute->rename(null, 'new_id')) {
33        echo "リネームに成功しました。" . PHP_EOL;
34        echo $dom->saveXML();
35    } else {
36        // 有効な名前であれば、通常この処理は実行されません
37        echo "リネームに失敗しました。（戻り値: false）" . PHP_EOL;
38    }
39    echo PHP_EOL;
40
41    // 4. 失敗するリネームの例
42    // 'new_id' を 'invalid name' という無効な名前に変更しようとします
43    // 失敗原因: XMLの属性名にスペースを含めることはできません。
44    echo "--- 失敗例: 'new_id' を無効な名前 'invalid name' にリネーム ---" . PHP_EOL;
45    try {
46        // この処理は無効な文字が含まれているため、DOMExceptionをスローします
47        $attribute->rename(null, 'invalid name');
48    } catch (DOMException $e) {
49        // 例外をキャッチし、失敗の原因となったメッセージを表示します
50        echo "リネームに失敗しました。原因: " . $e->getMessage() . PHP_EOL;
51    }
52
53    echo "--- 最終状態のXML (失敗したため変更なし) ---" . PHP_EOL;
54    echo $dom->saveXML();
55}
56
57// 関数を実行して結果を確認します
58demonstrateAttrRenameFailure();

このPHPサンプルコードは、Dom\Attr::rename()メソッドを使用してXMLの属性名を変更する方法と、その処理が失敗する原因を解説します。

Dom\Attr::rename()は、既存の属性の名前を変更するためのメソッドです。第1引数には名前空間URIを、第2引数には新しい属性名を文字列で指定します。

このメソッドが失敗する主な原因は、第2引数で指定した新しい属性名がXMLの命名規則に違反している場合です。例えば、名前にスペースを含んでいたり、数字から始まっていたりする名前は無効とみなされます。PHP 8以降では、このような無効な名前を指定すると、DOMExceptionというエラーが発生して処理が失敗します。

サンプルコードでは、まずoriginal_idという属性を作成し、new_idという有効な名前にリネームする成功例を示しています。次に、スペースを含む無効な名前invalid nameに変更しようと試みます。この操作はXMLのルールに反するためDOMExceptionが発生し、リネームに失敗する様子を確認できます。この結果、属性名は変更されずに処理が終了します。