【PHP8.x】DirectoryIterator::getInode()メソッドの使い方

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のXMLファイルを検索し、
5 * そのファイルのinode番号とXMLコンテンツ（ルート要素および直下の子要素）の情報を表示します。
6 *
7 * この関数はDirectoryIteratorを使用してディレクトリ内のファイルを反復処理し、
8 * 各ファイルのinode番号を取得します。また、XMLファイルが見つかった場合は
9 * XMLReaderを使用してその内容をストリーム形式で読み取り、主要な要素情報を表示します。
10 *
11 * @param string $directoryPath 検索対象のディレクトリパス
12 */
13function processXmlFilesInDirectory(string $directoryPath): void
14{
15    // ディレクトリが存在しない場合はエラーメッセージを表示して終了
16    if (!is_dir($directoryPath)) {
17        echo "Error: Directory '{$directoryPath}' not found.\n";
18        return;
19    }
20
21    echo "Processing directory: {$directoryPath}\n\n";
22
23    try {
24        // 指定されたディレクトリのイテレータを作成
25        $iterator = new DirectoryIterator($directoryPath);
26
27        foreach ($iterator as $fileInfo) {
28            // カレントディレクトリ (.) と親ディレクトリ (..) はスキップ
29            if ($fileInfo->isDot()) {
30                continue;
31            }
32
33            // ディレクトリはスキップ（ファイルのみを対象とする）
34            if ($fileInfo->isDir()) {
35                echo "Directory: {$fileInfo->getFilename()} (Skipping)\n\n";
36                continue;
37            }
38
39            // ファイルのinode番号を取得
40            // inodeはファイルシステム内でファイルを一意に識別する番号です。
41            $inode = $fileInfo->getInode();
42            echo "File: {$fileInfo->getFilename()} (Inode: {$inode}) ";
43
44            // ファイルがXMLファイルかどうかをチェック (拡張子で判断)
45            if ($fileInfo->isFile() && $fileInfo->getExtension() === 'xml') {
46                echo "[XML File]\n";
47                $filePath = $fileInfo->getPathname();
48
49                $reader = new XMLReader();
50                // XMLファイルを読み込みモードで開く
51                if ($reader->open($filePath)) {
52                    echo "  XML Content:\n";
53                    // XMLドキュメントをノードごとに読み進める
54                    while ($reader->read()) {
55                        // 現在のノードが要素ノードの場合
56                        if ($reader->nodeType === XMLReader::ELEMENT) {
57                            // XMLのルート要素 (深さ0の要素)
58                            if ($reader->depth === 0) {
59                                echo "    Root Element: <{$reader->name}>\n";
60                            }
61                            // ルート要素の直下の子要素 (深さ1の要素)
62                            else if ($reader->depth === 1) {
63                                echo "      - Child Element: <{$reader->name}>\n";
64                            }
65                            // これ以上深い階層の子ノードはここでは表示しません。
66                            // 必要に応じて depth をチェックして表示ロジックを追加できます。
67                        }
68                    }
69                    $reader->close(); // リーダーを閉じる
70                } else {
71                    echo "  Failed to open XML file for reading.\n";
72                }
73            } else {
74                echo "[Non-XML File]\n";
75            }
76            echo "\n";
77        }
78    } catch (UnexpectedValueException $e) {
79        // ディレクトリが開けないなどの例外を捕捉
80        echo "Error: Could not open directory '{$directoryPath}'. " . $e->getMessage() . "\n";
81    }
82}
83
84// --- サンプルコードの実行例 ---
85// テスト用のディレクトリとファイルを一時的に作成します。
86$testDir = __DIR__ . '/temp_xml_data';
87if (!is_dir($testDir)) {
88    mkdir($testDir);
89}
90
91// テスト用XMLファイル1
92file_put_contents($testDir . '/products.xml', <<<XML
93<?xml version="1.0" encoding="UTF-8"?>
94<catalog>
95    <product id="101">
96        <name>Laptop</name>
97        <price>1200</price>
98        <category>Electronics</category>
99    </product>
100    <product id="102">
101        <name>Mouse</name>
102        <price>25</price>
103        <category>Electronics</category>
104    </product>
105</catalog>
106XML);
107
108// テスト用XMLファイル2
109file_put_contents($testDir . '/users.xml', <<<XML
110<?xml version="1.0" encoding="UTF-8"?>
111<users>
112    <user uid="u001">
113        <username>alice</username>
114        <email>alice@example.com</email>
115    </user>
116    <user uid="u002">
117        <username>bob</username>
118        <email>bob@example.com</email>
119    </user>
120</users>
121XML);
122
123// テスト用非XMLファイル
124file_put_contents($testDir . '/readme.txt', "This is a plain text file for testing purposes.");
125
126// 関数を実行し、一時ディレクトリ内のファイルを処理
127processXmlFilesInDirectory($testDir);
128
129// 後処理: テスト用ファイルを削除し、ディレクトリをクリーンアップします。
130unlink($testDir . '/products.xml');
131unlink($testDir . '/users.xml');
132unlink($testDir . '/readme.txt');
133rmdir($testDir);
134
135?>

このPHPサンプルコードは、指定されたディレクトリ内のファイルを一つずつ調べて情報を表示する方法を示しています。DirectoryIteratorクラスを使用してディレクトリ内のファイルを効率的に反復処理し、それぞれのファイルに関する詳細な情報へアクセスします。

コードの中心であるgetInodeメソッドは、DirectoryIteratorが提供するfileInfoオブジェクト（ファイルのメタデータ）から、そのファイルのinode番号を取得するために使われます。inode番号はファイルシステム内でファイルを一意に識別するための整数値です。このメソッドは引数を一切必要とせず、呼び出すことで該当ファイルのinode番号を整数として返します。

サンプルコードでは、ファイルのパスとinode番号を表示した後、ファイルがXML形式であれば、さらにXMLReaderクラスを用いてその内容を読み込みます。XMLReaderはXMLファイルをストリーム形式で効率的に処理し、XMLドキュメントのルート要素やその直下にある子要素の情報を抽出して表示します。これにより、ファイルシステム上のファイル管理情報と、XMLデータの基本的な解析方法を同時に学ぶことができます。システムエンジニアを目指す方にとって、ファイルの識別とデータ内容の確認の基礎を理解するのに役立つでしょう。

Copy
1<?php
2
3/**
4 * DirectoryIterator::getInode の使用例
5 * 指定されたディレクトリ内の各ファイルおよびディレクトリのinode番号を取得し表示します。
6 * inode（アイノード）は、Unix系ファイルシステムにおいてファイルやディレクトリの
7 * メタデータ（所有者、パーミッション、作成日時など）を格納するデータ構造であり、
8 * ファイルシステム内で一意の識別子として機能します。
9 *
10 * @param string $path 情報を取得するディレクトリのパス
11 * @return void
12 */
13function displayDirectoryInodes(string $path): void
14{
15    // 指定されたパスが存在し、かつディレクトリであることを確認します。
16    if (!is_dir($path)) {
17        echo "エラー: 指定されたパス '{$path}' はディレクトリではありません。\n";
18        return;
19    }
20
21    try {
22        // DirectoryIterator を使用してディレクトリをイテレート（繰り返し処理）します。
23        // これにより、ディレクトリ内の各項目（ファイルやサブディレクトリ）にアクセスできます。
24        $iterator = new DirectoryIterator($path);
25
26        echo "ディレクトリ '{$path}' のinode情報:\n";
27        foreach ($iterator as $fileInfo) {
28            // '.' と '..' は特殊なディレクトリ参照であり、実際のファイルやディレクトリではないためスキップします。
29            if ($fileInfo->isDot()) {
30                continue;
31            }
32
33            // getInode() メソッドを呼び出して、現在のファイルまたはディレクトリのinode番号を取得します。
34            // inode番号はファイルシステム内で一意です。
35            echo sprintf(
36                "- %s (Inode: %d)\n",
37                $fileInfo->getFilename(),  // ファイルまたはディレクトリの名前
38                $fileInfo->getInode()      // 取得したinode番号
39            );
40        }
41    } catch (Exception $e) {
42        // ディレクトリの読み込み中にエラーが発生した場合、例外をキャッチしてメッセージを表示します。
43        echo "エラー: ディレクトリの読み込み中に問題が発生しました: " . $e->getMessage() . "\n";
44    }
45}
46
47// スクリプトが実行されているカレントディレクトリ（現在のディレクトリ）のinode情報を表示します。
48// システムエンジニアの初心者の方も、ご自身の環境でこのスクリプトを実行して、
49// ファイルシステムがどのようにデータを管理しているかの一端を観察できます。
50displayDirectoryInodes('.');
51
52// 特定のパスを指定したい場合は、以下のように変更できます。
53// 例: displayDirectoryInodes('/tmp'); // Linux/macOSの場合
54// 例: displayDirectoryInodes('C:\\Windows'); // Windowsの場合
55?>

DirectoryIterator::getInodeメソッドは、PHPでファイルシステム内のファイルやディレクトリのinode番号を取得するために使用されます。inodeとは、Unix系ファイルシステムにおいて、ファイルやディレクトリの所有者、パーミッション、作成日時といったメタデータを管理するデータ構造であり、ファイルシステム内で各項目を一意に識別するための番号です。

このサンプルコードは、DirectoryIteratorクラスを用いて指定されたディレクトリ内の各ファイルおよびサブディレクトリを順に処理し、それぞれの名前とそれに対応するinode番号を表示する例です。DirectoryIteratorは、ディレクトリの内容を効率的に繰り返し取得するためのクラスです。

getInodeメソッドは引数を必要とせず、呼び出されたファイルまたはディレクトリのinode番号を整数型（int）で返します。これにより、ファイルシステムがどのようにファイルを内部的に管理しているか、その一端を具体的に確認できます。システムエンジニアの初心者の方も、ご自身の環境でこのコードを実行し、ファイルシステムにおけるinodeの概念を実際に体験しながら学ぶことができます。