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

Copy
1<?php
2
3/**
4 * DirectoryIterator::getType() メソッドの使用例。
5 * このコードは、カレントディレクトリ内の各エントリ（ファイルやサブディレクトリなど）を走査し、
6 * そのエントリのタイプ（例: 'file'、'dir'、'link' など）を表示します。
7 */
8function demonstrateDirectoryIteratorGetType(): void
9{
10    echo "カレントディレクトリ ('.') のエントリタイプを一覧表示します:\n\n";
11
12    try {
13        // DirectoryIterator は、指定されたディレクトリ内のファイルやサブディレクトリを
14        // 一つずつ走査（イテレート）するためのクラスです。
15        // ここではカレントディレクトリ（'.'）を指定しています。
16        $iterator = new DirectoryIterator('.');
17
18        // ディレクトリ内の各エントリに対してループ処理を行います。
19        foreach ($iterator as $fileInfo) {
20            // getType() メソッドは、現在のエントリのタイプを文字列として返します。
21            // 例: 'file' (通常のファイル), 'dir' (ディレクトリ), 'link' (シンボリックリンク) など。
22            $type = $fileInfo->getType();
23
24            // エントリの名前と取得したタイプを表示します。
25            // getFilename() はエントリの名前（例: 'index.php', '.', '..'）を返します。
26            echo sprintf("名前: %-25s タイプ: %s\n", $fileInfo->getFilename(), $type);
27        }
28    } catch (UnexpectedValueException $e) {
29        // ディレクトリが存在しない、またはアクセス権がない場合に例外を捕捉します。
30        echo "エラー: ディレクトリにアクセスできませんでした。メッセージ: " . $e->getMessage() . "\n";
31    }
32}
33
34// 関数を実行します。
35demonstrateDirectoryIteratorGetType();
36
37?>

PHPのDirectoryIterator::getType()メソッドは、ファイルシステムのエントリがどのような種類であるかを識別するために使用されます。このメソッドは、DirectoryIteratorクラスに属しており、指定されたディレクトリ内のファイルやサブディレクトリなどの各エントリを一つずつ処理する際に利用されます。引数は必要なく、現在のエントリのタイプを文字列（string）として返します。例えば、通常のファイルであれば「file」、ディレクトリであれば「dir」、シンボリックリンクであれば「link」といった値が戻り値となります。

提供されたサンプルコードでは、DirectoryIteratorクラスを使用して現在のディレクトリ（.）を走査しています。ループ処理の中で、各エントリに対してgetType()メソッドを呼び出すことで、そのエントリがファイルなのか、ディレクトリなのかなどの種類を取得しています。取得した種類は、getFilename()メソッドで得られるエントリの名前とともに画面に表示されます。これにより、ディレクトリ内の各エントリがどのようなタイプであるかを一覧で確認できます。また、ディレクトリへのアクセスに問題がある場合には、try-catchブロックによってエラーを捕捉し、適切なメッセージを表示する処理も含まれています。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内の各エントリのファイルシステム型を表示します。
5 * DirectoryIterator::getType() メソッドの使用例を示します。
6 *
7 * @param string $directoryPath 走査するディレクトリのパス。
8 * @return void
9 */
10function demonstrateDirectoryEntryTypes(string $directoryPath): void
11{
12    // 指定されたパスがディレクトリでない場合、エラーメッセージを表示して終了します。
13    if (!is_dir($directoryPath)) {
14        echo "エラー: ディレクトリ '{$directoryPath}' が見つからないか、アクセスできません。\n";
15        return;
16    }
17
18    echo "ディレクトリ '{$directoryPath}' の内容を走査しています:\n";
19
20    try {
21        // DirectoryIterator を使用してディレクトリを反復処理します。
22        // 各エントリは DirectoryIterator オブジェクトとして扱えます。
23        foreach (new DirectoryIterator($directoryPath) as $fileInfo) {
24            // '.' と '..' は特殊なエントリなのでスキップします。
25            // これらはそれぞれカレントディレクトリと親ディレクトリを表します。
26            if ($fileInfo->isDot()) {
27                continue;
28            }
29
30            // エントリの名前 (ファイル名またはディレクトリ名) を取得します。
31            $name = $fileInfo->getFilename();
32            // getType() メソッドでエントリの型 ('file', 'dir', 'link' など) を文字列で取得します。
33            $type = $fileInfo->getType();
34
35            echo "  - {$name} (型: {$type})\n";
36        }
37    } catch (UnexpectedValueException $e) {
38        // ディレクトリが存在しない、アクセス権がないなどの場合に例外を捕捉します。
39        echo "エラー: ディレクトリ '{$directoryPath}' の読み取り中に問題が発生しました。 " . $e->getMessage() . "\n";
40    }
41}
42
43// ---------------------------------------------------
44// サンプル実行部分
45// ---------------------------------------------------
46
47// 一時的なディレクトリを作成し、テスト用のファイルとサブディレクトリを配置します。
48// '__DIR__' は現在のスクリプトがあるディレクトリのパスを返します。
49$tempDirPath = __DIR__ . DIRECTORY_SEPARATOR . 'demo_dir_for_gettype';
50
51// ディレクトリが既に存在しない場合のみ作成します。
52// 'true' を指定することで、親ディレクトリが存在しない場合も再帰的に作成されます。
53if (!is_dir($tempDirPath)) {
54    mkdir($tempDirPath, 0777, true);
55}
56
57// テスト用のファイルを作成します。
58$testFilePath = $tempDirPath . DIRECTORY_SEPARATOR . 'sample_file.txt';
59file_put_contents($testFilePath, 'このファイルはテスト用です。');
60
61// テスト用のサブディレクトリを作成します。
62$testSubDirPath = $tempDirPath . DIRECTORY_SEPARATOR . 'sub_directory';
63if (!is_dir($testSubDirPath)) {
64    mkdir($testSubDirPath, 0777);
65}
66
67echo "--- DirectoryIterator::getType() の使用例 ---\n\n";
68
69// 作成した一時ディレクトリの内容を表示し、各エントリの型を確認します。
70demonstrateDirectoryEntryTypes($tempDirPath);
71
72echo "\n--- サンプル実行終了 ---\n";
73
74// ---------------------------------------------------
75// 後処理: 作成した一時的なファイルとディレクトリを削除します。
76// ---------------------------------------------------
77
78// サブディレクトリ内のファイルを削除します (もしあれば)。
79if (is_dir($testSubDirPath)) {
80    $subDirFiles = glob($testSubDirPath . DIRECTORY_SEPARATOR . '*'); // サブディレクトリ内の全てのファイルを取得
81    if ($subDirFiles) {
82        foreach ($subDirFiles as $file) {
83            if (is_file($file)) {
84                unlink($file); // ファイルを削除
85            }
86        }
87    }
88    rmdir($testSubDirPath); // 空になったサブディレクトリを削除
89}
90
91// メインディレクトリ内のファイルを削除します。
92if (file_exists($testFilePath)) {
93    unlink($testFilePath);
94}
95
96// 一時ディレクトリを削除します。
97if (is_dir($tempDirPath)) {
98    rmdir($tempDirPath);
99}
100
101?>

PHP 8のDirectoryIteratorクラスは、指定したディレクトリの内容を一つずつ調べて操作するために使われます。このクラスに属するgetType()メソッドは、ディレクトリ内の各エントリ（ファイルやサブディレクトリなど）がファイルシステム上でどのような種類であるかを示す文字列を取得します。このメソッドには引数は必要ありません。戻り値はstring型で、例えば「file」（通常のファイル）、「dir」（ディレクトリ）、「link」（シンボリックリンク）といったエントリの型を文字列として返します。

提供されたサンプルコードでは、DirectoryIteratorを使って特定のディレクトリを走査し、見つかった各エントリについて、その名前とともにgetType()メソッドで取得した型を表示しています。これにより、ディレクトリ内のどの項目がファイルで、どれがディレクトリであるかなどをプログラムから簡単に識別できます。例えば、ファイルの中身を読み込む処理や、サブディレクトリを再帰的に探索する処理など、エントリの型に応じて異なる操作を行う際に、このgetType()メソッドで得られる情報が非常に役立ちます。getType()はファイルシステムを扱うプログラムで基本的な情報取得に利用される重要なメソッドです。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリ内の各エントリのタイプ（ファイル、ディレクトリなど）を表示します。
5 *
6 * この関数は、DirectoryIterator を使用してディレクトリを走査し、
7 * 各エントリ（ファイルやサブディレクトリ）の名前と getType() メソッドで取得したタイプを出力します。
8 * getType() メソッドは、エントリが 'file' (ファイル)、'dir' (ディレクトリ)、
9 * 'link' (シンボリックリンク) など、どのタイプであるかを文字列 (string) で返します。
10 *
11 * @param string $path 走査するディレクトリのパス。デフォルトはカレントディレクトリ（'.'）。
12 */
13function displayDirectoryEntryTypes(string $path = '.'): void
14{
15    try {
16        // 指定されたパスのDirectoryIteratorを作成します。
17        // これにより、ディレクトリ内のファイルやサブディレクトリを順番に処理できるようになります。
18        $iterator = new DirectoryIterator($path);
19
20        echo "--- ディレクトリ '{$path}' のエントリタイプ ---" . PHP_EOL;
21
22        // ディレクトリ内の各エントリをループ処理します。
23        foreach ($iterator as $fileInfo) {
24            // エントリの名前（ファイル名またはディレクトリ名）を取得します。
25            $name = $fileInfo->getFilename();
26
27            // エントリのタイプを取得します。戻り値は string 型です。
28            // 例: 'file', 'dir', 'link', 'fifo', 'char', 'block', 'unknown'
29            $type = $fileInfo->getType();
30
31            // エントリの名前とタイプを出力します。
32            // %-25s は、文字列を左詰め25文字で表示するための書式指定子です。
33            echo sprintf("名前: %-25s タイプ: %s" . PHP_EOL, $name, $type);
34        }
35
36        echo "------------------------------------------------" . PHP_EOL;
37
38    } catch (UnexpectedValueException $e) {
39        // 指定されたディレクトリが存在しない、またはアクセスできない場合に発生するエラーを捕捉します。
40        echo "エラー: ディレクトリ '{$path}' を開けませんでした。メッセージ: " . $e->getMessage() . PHP_EOL;
41    }
42}
43
44// サンプルコードを実行します。
45// このスクリプトが実行されているカレントディレクトリのエントリタイプを表示します。
46displayDirectoryEntryTypes();
47
48// 必要に応じて、別のディレクトリを指定して試すこともできます。
49// 例:
50// displayDirectoryEntryTypes('/tmp'); // Linux/macOSの場合
51// displayDirectoryEntryTypes('C:\\Windows'); // Windowsの場合
52?>

このPHPサンプルコードは、指定されたディレクトリ内の各エントリ（ファイルやサブディレクトリ）がどのような種類であるか、その「タイプ」を調べて表示する方法を示しています。

核心となるのは、DirectoryIteratorクラスのgetType()メソッドです。このメソッドは、引数を必要とせず、対象のエントリがファイルであれば 'file'、ディレクトリであれば 'dir'、シンボリックリンクであれば 'link' のように、そのタイプをstring型の文字列として返します。戻り値は常に文字列であり、エントリの種類を正確に識別できます。

サンプルコードでは、displayDirectoryEntryTypes関数内でDirectoryIteratorを初期化し、指定されたディレクトリ内の各エントリを順番に処理しています。ループ内でgetType()メソッドを呼び出すことで、各エントリの名前とともにその種類（タイプ）を取得し、画面に分かりやすく出力しています。これにより、ディレクトリの中身がファイルなのかディレクトリなのかといった情報を簡単に把握できます。また、指定されたディレクトリが存在しない場合やアクセスできない場合には、エラーを捕捉してメッセージを表示する堅牢な作りになっています。