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

Copy
1<?php
2
3// SplFileInfo クラスと isDir() メソッドの基本的な使い方を示すサンプルコードです。
4// このコードは一時的なディレクトリとファイルを作成し、それらのパスがディレクトリであるかを確認します。
5
6// 1. テスト用のパスを定義
7$testDirPath = __DIR__ . DIRECTORY_SEPARATOR . 'example_directory';
8$testFilePath = __DIR__ . DIRECTORY_SEPARATOR . 'example_file.txt';
9
10// 2. テスト環境のセットアップ
11// 既存のテスト用ディレクトリやファイルがあれば、クリーンアップします。
12if (file_exists($testDirPath)) {
13    @rmdir($testDirPath); // @ を付けてエラー抑制 (ディレクトリが空でない場合など)
14}
15if (file_exists($testFilePath)) {
16    @unlink($testFilePath);
17}
18
19// テスト用のディレクトリを作成
20if (!mkdir($testDirPath, 0777, true)) {
21    exit("エラー: ディレクトリ '{$testDirPath}' の作成に失敗しました。" . PHP_EOL);
22}
23// テスト用のファイルを作成
24if (file_put_contents($testFilePath, 'これはテストファイルです。') === false) {
25    exit("エラー: ファイル '{$testFilePath}' の作成に失敗しました。" . PHP_EOL);
26}
27
28echo "--- SplFileInfo::isDir() の動作確認 ---" . PHP_EOL . PHP_EOL;
29
30// 3. ディレクトリパスの検査
31echo "パス: '{$testDirPath}' の検査:" . PHP_EOL;
32// SplFileInfo オブジェクトを生成し、ディレクトリかどうかをチェックします。
33$dirInfo = new SplFileInfo($testDirPath);
34if ($dirInfo->isDir()) {
35    echo "  結果: これはディレクトリです。" . PHP_EOL;
36} else {
37    echo "  結果: これはディレクトリではありません。" . PHP_EOL;
38}
39echo PHP_EOL;
40
41// 4. ファイルパスの検査
42echo "パス: '{$testFilePath}' の検査:" . PHP_EOL;
43// 同様に、ファイルパスがディレクトリかどうかをチェックします。
44$fileInfo = new SplFileInfo($testFilePath);
45if ($fileInfo->isDir()) {
46    echo "  結果: これはディレクトリです。" . PHP_EOL;
47} else {
48    echo "  結果: これはディレクトリではありません。" . PHP_EOL;
49}
50echo PHP_EOL;
51
52// 5. 存在しないパスの検査
53$nonExistentPath = __DIR__ . DIRECTORY_SEPARATOR . 'non_existent_path';
54echo "パス: '{$nonExistentPath}' の検査 (存在しないパス):" . PHP_EOL;
55// 存在しないパスはディレクトリではないため、false を返します。
56$nonExistentInfo = new SplFileInfo($nonExistentPath);
57if ($nonExistentInfo->isDir()) {
58    echo "  結果: これはディレクトリです。" . PHP_EOL;
59} else {
60    echo "  結果: これはディレクトリではありません。" . PHP_EOL;
61}
62echo PHP_EOL;
63
64// 6. テスト環境のクリーンアップ
65echo "--- テスト環境のクリーンアップ ---" . PHP_EOL;
66if (file_exists($testDirPath)) {
67    if (rmdir($testDirPath)) {
68        echo "  テストディレクトリ '{$testDirPath}' を削除しました。" . PHP_EOL;
69    } else {
70        echo "  警告: テストディレクトリ '{$testDirPath}' の削除に失敗しました。" . PHP_EOL;
71    }
72}
73if (file_exists($testFilePath)) {
74    if (unlink($testFilePath)) {
75        echo "  テストファイル '{$testFilePath}' を削除しました。" . PHP_EOL;
76    } else {
77        echo "  警告: テストファイル '{$testFilePath}' の削除に失敗しました。" . PHP_EOL;
78    }
79}
80
81?>

PHP 8のSplFileInfoクラスに属するisDir()メソッドは、指定されたパスがディレクトリ（フォルダ）であるかどうかを判定するために使用されます。このメソッドは引数を一切取らず、戻り値としてbool型（真偽値）を返します。具体的には、パスが実際に存在し、かつそれがディレクトリであればtrueを、ファイルや存在しないパス、または何らかの理由でディレクトリではない場合はfalseを返します。

提供されたサンプルコードでは、このisDir()メソッドの基本的な使い方を示しています。まず、一時的なテスト用ディレクトリとファイルをプログラム内で作成します。次に、作成したディレクトリのパスに対してSplFileInfoオブジェクトを生成し、isDir()メソッドを呼び出すとtrueが返され、それがディレクトリであることが確認できます。一方で、作成したファイルのパスや、そもそも存在しないパスに対してisDir()を呼び出した場合はfalseが返されることが示されています。

このように、SplFileInfo::isDir()メソッドを利用することで、プログラム中でファイルやディレクトリの操作を行う前に、対象のパスがディレクトリであるかを簡単かつ正確に判別できます。サンプルコードの最後では、テスト用に作成したファイルやディレクトリを適切に削除し、実行環境をクリーンアップしています。

Copy
1<?php
2
3/**
4 * SplFileInfo::isDir() メソッドの使用例を示します。
5 * このメソッドは、指定されたパスがディレクトリであるかどうかを判定します。
6 *
7 * システムエンジニアを目指す初心者がファイルシステムの情報を扱う際の一例として、
8 * パスがディレクトリであるかどうかの確認によく利用されます。
9 */
10function demonstrateSplFileInfoIsDir(): void
11{
12    echo "--- SplFileInfo::isDir() の使用例 ---\n\n";
13
14    // 1. 現在のスクリプトファイルがあるディレクトリを指すSplFileInfoオブジェクト
15    // 例: /path/to/your/script_directory
16    $currentDirectoryPath = __DIR__;
17    $infoForCurrentDir = new SplFileInfo($currentDirectoryPath);
18    echo "パス: '" . $infoForCurrentDir->getPathname() . "'\n";
19    // isDir() は、パスがディレクトリであれば true を返します。
20    echo "isDir() の結果: " . ($infoForCurrentDir->isDir() ? 'true (ディレクトリです)' : 'false (ディレクトリではありません)') . "\n\n";
21
22    // 2. 現在のスクリプトファイルを指すSplFileInfoオブジェクト
23    // 例: /path/to/your/script_directory/example.php
24    $currentFilePath = __FILE__;
25    $infoForCurrentFile = new SplFileInfo($currentFilePath);
26    echo "パス: '" . $infoForCurrentFile->getPathname() . "'\n";
27    // isDir() は、パスがファイルであれば false を返します。
28    echo "isDir() の結果: " . ($infoForCurrentFile->isDir() ? 'true (ディレクトリです)' : 'false (ディレクトリではありません)') . "\n\n";
29
30    // 3. 存在しないパスを指すSplFileInfoオブジェクト
31    $nonExistentPath = __DIR__ . DIRECTORY_SEPARATOR . 'non_existent_folder_' . uniqid();
32    $infoForNonExistent = new SplFileInfo($nonExistentPath);
33    echo "パス: '" . $infoForNonExistent->getPathname() . "'\n";
34    // 存在しないパスの場合、isDir() は false を返します。
35    echo "isDir() の結果: " . ($infoForNonExistent->isDir() ? 'true (ディレクトリです)' : 'false (ディレクトリではありません)') . "\n\n";
36
37    echo "--- SplFileInfo::isDir() は、ファイルシステム上の指定パスが「ディレクトリ」であるかをブール値で報告します。 --- \n";
38}
39
40// 関数を実行して、SplFileInfo::isDir() の動作を確認します。
41demonstrateSplFileInfoIsDir();

PHPのSplFileInfo::isDir()メソッドは、ファイルシステム上の指定されたパスがディレクトリ（フォルダ）であるかどうかを判定するために使用されます。このメソッドはSplFileInfoクラスのメンバーであり、オブジェクトが表現するパスについて情報を提供します。

引数は不要で、呼び出すだけで機能します。戻り値はブール値（trueまたはfalse）です。具体的には、指定されたパスが実際に存在するディレクトリであればtrueを返し、ファイルであったり、存在しないパスであったり、ディレクトリでなければfalseを返します。

サンプルコードでは、現在のスクリプトがあるディレクトリのパスに対してisDir()を適用するとtrueとなる一方、スクリプトファイル自体のパスや存在しない架空のパスに対してはfalseとなることが示されています。システムエンジニアを目指す初心者がファイルシステムを操作する際、パスがディレクトリであるかを安全に確認するために、このメソッドは非常に役立ちます。