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

Copy
1<?php
2
3/**
4 * 指定されたディレクトリを再帰的に走査し、ファイルやディレクトリのinode情報を表示します。
5 * inodeはファイルシステム内のファイルやディレクトリを一意に識別する番号です。
6 *
7 * @param string $directoryPath 走査するディレクトリのパス
8 */
9function displayDirectoryInodeInfo(string $directoryPath): void
10{
11    // 指定されたパスがディレクトリとして存在するか確認します。
12    if (!is_dir($directoryPath)) {
13        echo "エラー: ディレクトリ '{$directoryPath}' が見つかりません。\n";
14        return;
15    }
16
17    echo "--- ディレクトリ '{$directoryPath}' のinode情報 ---\n";
18
19    try {
20        // RecursiveDirectoryIteratorはディレクトリの内容をイテレーションするためのクラスです。
21        // FilesystemIterator::SKIP_DOTS を使用して、'.' (カレントディレクトリ) と '..' (親ディレクトリ) のエントリをスキップします。
22        $iterator = new RecursiveDirectoryIterator(
23            $directoryPath,
24            FilesystemIterator::SKIP_DOTS
25        );
26
27        // RecursiveIteratorIteratorは、RecursiveDirectoryIteratorと組み合わせて、ディレクトリツリーを再帰的に走査します。
28        // RecursiveIteratorIterator::SELF_FIRST は、ディレクトリ自体をその内容よりも先に処理することを意味します。
29        $recursiveIterator = new RecursiveIteratorIterator(
30            $iterator,
31            RecursiveIteratorIterator::SELF_FIRST
32        );
33
34        // 各ファイルまたはディレクトリに対してループ処理を行います。
35        /** @var SplFileInfo $fileInfo */
36        foreach ($recursiveIterator as $fileInfo) {
37            // 現在のファイルまたはディレクトリのフルパスを取得します。
38            $path = $fileInfo->getPathname();
39            // getInode() メソッドを使用して、ファイルまたはディレクトリのinode番号を取得します。
40            // getInode() は int 型のinode番号を返します。
41            $inode = $fileInfo->getInode();
42
43            if ($fileInfo->isDir()) {
44                // ディレクトリの場合
45                echo "ディレクトリ: {$path} (Inode: {$inode})\n";
46            } else {
47                // ファイルの場合
48                echo "ファイル:      {$path} (Inode: {$inode})\n";
49            }
50        }
51    } catch (Exception $e) {
52        echo "エラーが発生しました: " . $e->getMessage() . "\n";
53    }
54    echo "------------------------------------------------\n";
55}
56
57/**
58 * デモンストレーション用のサンプルディレクトリ構造を作成します。
59 *
60 * @param string $baseDir サンプルディレクトリを作成するパス
61 */
62function createSampleDirectory(string $baseDir): void
63{
64    if (!is_dir($baseDir)) {
65        // ディレクトリが存在しない場合は、再帰的に作成します。
66        mkdir($baseDir, 0777, true);
67        echo "サンプルディレクトリを作成しました: {$baseDir}\n";
68    }
69
70    // いくつかのファイルとサブディレクトリを作成します。
71    file_put_contents("{$baseDir}/file1.txt", "これはファイル1の内容です。");
72    mkdir("{$baseDir}/subdir1");
73    file_put_contents("{$baseDir}/subdir1/file2.txt", "これはファイル2の内容です。");
74    mkdir("{$baseDir}/subdir1/subdir2");
75    file_put_contents("{$baseDir}/subdir1/subdir2/file3.txt", "これはファイル3の内容です。");
76    echo "サンプルディレクトリにファイルとサブディレクトリを配置しました。\n";
77}
78
79/**
80 * デモンストレーション用に作成したサンプルディレクトリとその内容を再帰的に削除します。
81 *
82 * @param string $baseDir 削除するディレクトリのパス
83 */
84function deleteSampleDirectory(string $baseDir): void
85{
86    if (!is_dir($baseDir)) {
87        return;
88    }
89
90    $iterator = new RecursiveDirectoryIterator($baseDir, FilesystemIterator::SKIP_DOTS);
91    $recursiveIterator = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::CHILD_FIRST);
92
93    // ディレクトリ内のすべてのファイルとサブディレクトリを削除します。
94    foreach ($recursiveIterator as $fileInfo) {
95        if ($fileInfo->isDir()) {
96            rmdir($fileInfo->getPathname()); // サブディレクトリを削除
97        } else {
98            unlink($fileInfo->getPathname()); // ファイルを削除
99        }
100    }
101    rmdir($baseDir); // 最上位のサンプルディレクトリを削除
102    echo "サンプルディレクトリをクリーンアップしました: {$baseDir}\n";
103}
104
105// --- メインの実行処理 ---
106
107// デモンストレーション用の一時ディレクトリパスを定義します。
108$sampleDir = __DIR__ . '/sample_inodes';
109
110// 1. サンプルディレクトリ構造を作成します。
111createSampleDirectory($sampleDir);
112
113// 2. 作成したサンプルディレクトリのinode情報を表示します。
114// ここで RecursiveDirectoryIterator::getInode メソッドが使用されます。
115displayDirectoryInodeInfo($sampleDir);
116
117// 3. デモンストレーション後にサンプルディレクトリをクリーンアップ（削除）します。
118deleteSampleDirectory($sampleDir);
119
120?>

このPHPのサンプルコードは、RecursiveDirectoryIteratorクラスと、そこから得られるファイル情報のgetInodeメソッドの利用方法を分かりやすく示しています。RecursiveDirectoryIteratorは、指定されたディレクトリとそのサブディレクトリを再帰的に走査し、ファイルシステム内のすべての要素にアクセスするための機能を提供します。

getInodeメソッドは引数を取らずに呼び出され、ファイルやディレクトリを一意に識別する整数値、いわゆるinode番号を返します。このinode番号は、ファイルシステムが内部的にオブジェクトを管理するために使用する識別子です。

サンプルコードでは、まずデモンストレーション用のディレクトリ構造が作成されます。その後、displayDirectoryInodeInfo関数内でRecursiveDirectoryIteratorとRecursiveIteratorIteratorを組み合わせてディレクトリツリー全体を再帰的に走査しています。ループの中で、各ファイルやディレクトリの情報を表すSplFileInfoオブジェクトからgetInode()メソッドを呼び出し、取得したinode番号とそのパスを画面に表示します。これにより、ファイルシステム上の各要素が持つユニークな識別子を確認できます。最後に、作成したサンプルディレクトリはクリーンアップ（削除）されます。このメソッドは、ファイルシステムにおける低レベルなファイル識別子をプログラムから取得したい場合に役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内のファイルやサブディレクトリを再帰的に探索し、
5 * 各アイテムの inode 番号を取得するPHPスクリプト。
6 *
7 * RecursiveDirectoryIterator::getInode() メソッドの使用例です。
8 * inode (インデックスノード) は、Unix系ファイルシステムにおいてファイルや
9 * ディレクトリを一意に識別するための内部的な番号です。
10 *
11 * このスクリプトは一時ディレクトリを作成し、テスト用のファイルとサブディレクトリを配置した後、
12 * RecursiveDirectoryIterator を用いてそれらを走査し、各アイテムの inode 番号を表示します。
13 * 最後に、作成した一時ディレクトリとファイルをクリーンアップします。
14 *
15 * システムエンジニアを目指す初心者の方へ：
16 * ファイルシステムを扱う際、ファイルの内容だけでなく、そのメタデータ（作成日時、サイズ、そしてinode番号など）
17 * を取得することがあります。inode番号は特に、同じ名前のファイルが異なる場所にある場合や、
18 * ファイルのハードリンクなどを識別する際に役立ちます。
19 */
20function demonstrateInodeRetrieval(): void
21{
22    // 一時ディレクトリを作成するパスを定義
23    $tempDirPath = __DIR__ . '/temp_inode_test_dir';
24
25    // 既存の場合は一度削除し、新たに作成
26    if (is_dir($tempDirPath)) {
27        deleteDirectory($tempDirPath);
28    }
29    mkdir($tempDirPath);
30
31    // テスト用のファイルとサブディレクトリを作成
32    file_put_contents($tempDirPath . '/document.txt', 'これはテスト用のテキストファイルです。');
33    file_put_contents($tempDirPath . '/image.jpg', 'ダミーコンテンツ'); // inode を確認するための中身のないファイル
34    mkdir($tempDirPath . '/sub_folder');
35    file_put_contents($tempDirPath . '/sub_folder/report.pdf', 'これはサブフォルダ内のファイルです。');
36
37    echo "=== '{$tempDirPath}' 内のファイルシステムアイテムのInode番号 ===\n";
38
39    try {
40        // RecursiveDirectoryIterator を初期化し、"."と".."を除外
41        $directoryIterator = new RecursiveDirectoryIterator(
42            $tempDirPath,
43            RecursiveDirectoryIterator::SKIP_DOTS
44        );
45        // 再帰的にディレクトリを探索するためのイテレータを作成
46        $recursiveIterator = new RecursiveIteratorIterator(
47            $directoryIterator,
48            RecursiveIteratorIterator::SELF_FIRST // ディレクトリ自身も最初にリストに含める
49        );
50
51        foreach ($recursiveIterator as $fileInfo) {
52            // RecursiveDirectoryIterator::getInode() メソッドを呼び出し、inode 番号を取得
53            $inode = $fileInfo->getInode();
54
55            // アイテムのパス、タイプ、および inode 番号を表示
56            echo sprintf(
57                "パス: %s, タイプ: %s, Inode: %d\n",
58                $fileInfo->getPathname(),
59                $fileInfo->isFile() ? 'ファイル' : ($fileInfo->isDir() ? 'ディレクトリ' : 'その他'),
60                $inode
61            );
62        }
63    } catch (Exception $e) {
64        echo "エラーが発生しました: " . $e->getMessage() . "\n";
65    } finally {
66        // 後処理: 作成した一時ディレクトリとファイルを削除
67        echo "\n=== クリーンアップ ===\n";
68        if (is_dir($tempDirPath)) {
69            deleteDirectory($tempDirPath);
70            echo "一時ディレクトリ '{$tempDirPath}' を削除しました。\n";
71        }
72    }
73}
74
75/**
76 * 指定されたディレクトリを再帰的に削除するヘルパー関数。
77 *
78 * @param string $dir 削除するディレクトリのパス
79 * @return void
80 */
81function deleteDirectory(string $dir): void
82{
83    if (!is_dir($dir)) {
84        return;
85    }
86    $files = array_diff(scandir($dir), ['.', '..']);
87    foreach ($files as $file) {
88        (is_dir("$dir/$file")) ? deleteDirectory("$dir/$file") : unlink("$dir/$file");
89    }
90    rmdir($dir);
91}
92
93// 関数の実行
94demonstrateInodeRetrieval();

RecursiveDirectoryIterator::getInode() メソッドは、PHPでファイルシステム内のファイルやディレクトリのinode（アイノード）番号を取得するために使用されます。inode番号とは、Unix系OSのファイルシステムにおいて、ファイルやディレクトリを内容ではなく、内部的に一意に識別するための管理番号です。ファイル名、パーミッション、所有者、作成日時、サイズ、そしてデータが格納されている場所などのメタデータがこのinodeに結びついています。

このメソッドは引数を一切必要とせず、呼び出すだけで対象のファイルまたはディレクトリに割り当てられたinode番号を整数型（int）として返します。

提供されたサンプルコードでは、一時的なディレクトリを作成し、その中にテスト用のファイルやサブディレクトリを配置しています。その後、RecursiveDirectoryIteratorとRecursiveIteratorIteratorを用いてディレクトリ内を再帰的に走査し、各ファイルやディレクトリに対して getInode() メソッドを呼び出しています。これにより、ファイルシステム内の各アイテムが持つ一意なinode番号が画面に表示され、その取得方法を具体的に確認できます。

システムエンジニアを目指す方にとって、ファイルシステムの仕組みを理解することは重要です。inode番号は、ファイルのハードリンクの識別や、同じ名前の異なるファイルが実際にシステム上でどのように扱われているかを確認する際など、ファイルシステムの詳細な管理やトラブルシューティングで役立つ低レベルな情報となります。