【PHP8.x】RecursiveDirectoryIterator::UNIX_PATHS定数の使い方

Copy
1<?php
2
3/**
4 * RecursiveDirectoryIterator::UNIX_PATHS を使用して、指定されたディレクトリの内容を
5 * Unix形式のパスで一覧表示します。
6 *
7 * この関数は、システムエンジニアがファイルシステムを扱う際、
8 * オペレーティングシステムに関わらず一貫したパス形式（Unixスタイル）で
9 * パスを取得する方法を示します。
10 *
11 * @param string $directoryPath 走査するディレクトリのパス。
12 * @return void
13 */
14function listDirectoryContentsWithUnixPaths(string $directoryPath): void
15{
16    // ディレクトリが存在しない場合はエラーメッセージを表示して終了します。
17    if (!is_dir($directoryPath)) {
18        echo "エラー: 指定されたディレクトリ '{$directoryPath}' が見つかりません。\n";
19        return;
20    }
21
22    echo "--- ディレクトリ '{$directoryPath}' の内容をUnix形式パスで一覧表示します ---\n";
23
24    try {
25        // RecursiveDirectoryIterator はディレクトリを再帰的に走査するためのイテレータです。
26        // RecursiveDirectoryIterator::UNIX_PATHS フラグを指定すると、
27        // Windows環境であっても、取得されるパスの区切り文字が常に '/' (Unixスタイル) になります。
28        $directoryIterator = new RecursiveDirectoryIterator(
29            $directoryPath,
30            RecursiveDirectoryIterator::UNIX_PATHS // この定数によりUnix形式パスが強制されます
31        );
32
33        // RecursiveIteratorIterator は、RecursiveDirectoryIterator をラップして、
34        // サブディレクトリ内も自動的に再帰的に処理するために使用します。
35        // SELF_FIRST は、現在のディレクトリ（またはファイル）を先に処理し、
36        // その後でサブディレクトリの内容を処理することを意味します。
37        $iterator = new RecursiveIteratorIterator(
38            $directoryIterator,
39            RecursiveIteratorIterator::SELF_FIRST
40        );
41
42        // イテレータを使用して、ディレクトリ内のすべてのファイルとディレクトリを反復処理します。
43        foreach ($iterator as $fileInfo) {
44            // SplFileInfo オブジェクトからファイルまたはディレクトリのパスを取得します。
45            // UNIX_PATHS フラグの効果により、パスは常にUnix形式で表示されます。
46            // 例: /path/to/file.txt
47            echo $fileInfo->getPathname() . "\n";
48        }
49    } catch (Exception $e) {
50        echo "エラー: ディレクトリ走査中に問題が発生しました - " . $e->getMessage() . "\n";
51    }
52
53    echo "--- 処理終了 ---\n";
54}
55
56// -----------------------------------------------------------------------------
57// サンプルコード実行部分
58// この部分は、上記の関数の動作を確認するためのデモンストレーションです。
59// -----------------------------------------------------------------------------
60
61// デモンストレーション用に一時的なディレクトリとファイルを作成します。
62$tempDemoDir = __DIR__ . '/php_unix_paths_demo_dir';
63try {
64    if (!is_dir($tempDemoDir)) {
65        mkdir($tempDemoDir);
66    }
67    file_put_contents($tempDemoDir . '/test_file_1.txt', 'Sample Content 1');
68    mkdir($tempDemoDir . '/sub_directory');
69    file_put_contents($tempDemoDir . '/sub_directory/test_file_2.txt', 'Sample Content 2');
70
71    // 作成した一時ディレクトリの内容をUnix形式パスで表示する関数を呼び出します。
72    listDirectoryContentsWithUnixPaths($tempDemoDir);
73
74} catch (Exception $e) {
75    echo "エラー: デモンストレーション用の環境準備中に問題が発生しました - " . $e->getMessage() . "\n";
76} finally {
77    // デモンストレーション用に作成した一時ファイルをクリーンアップします。
78    // この処理は、スクリプト実行後に不要なファイルが残らないようにするために重要です。
79    if (is_dir($tempDemoDir)) {
80        // サブディレクトリ内のファイルを削除
81        if (file_exists($tempDemoDir . '/sub_directory/test_file_2.txt')) {
82            unlink($tempDemoDir . '/sub_directory/test_file_2.txt');
83        }
84        // サブディレクトリを削除
85        if (is_dir($tempDemoDir . '/sub_directory')) {
86            rmdir($tempDemoDir . '/sub_directory');
87        }
88        // ルートディレクトリ内のファイルを削除
89        if (file_exists($tempDemoDir . '/test_file_1.txt')) {
90            unlink($tempDemoDir . '/test_file_1.txt');
91        }
92        // ルートディレクトリを削除
93        rmdir($tempDemoDir);
94        echo "\nデモンストレーション用のディレクトリ '{$tempDemoDir}' をクリーンアップしました。\n";
95    }
96}

このPHPコードは、RecursiveDirectoryIterator::UNIX_PATHS定数を使用し、指定されたディレクトリ内のファイルやサブディレクトリのパスを、オペレーティングシステムに関わらず常にUnix形式（スラッシュ区切り）で一覧表示する方法を示しています。この定数は、Windows環境などであっても、パス区切り文字がバックスラッシュではなく、Unixスタイルのスラッシュ（/）になるように強制する役割があります。

システムエンジニアにとって、この機能はクロスプラットフォームなアプリケーション開発において非常に重要です。異なるOS間でパスの形式を統一することで、パス処理のコードをシンプルにし、互換性の問題を回避できます。

listDirectoryContentsWithUnixPaths関数は、走査したいディレクトリのパスを文字列型$directoryPathとして引数に取ります。戻り値はvoidであり、結果を直接返さず、処理されたパスを画面に直接出力します。関数内では、RecursiveDirectoryIteratorのインスタンスを生成する際にRecursiveDirectoryIterator::UNIX_PATHSを指定し、その後のRecursiveIteratorIteratorによる再帰的な走査を通じて、SplFileInfoオブジェクトから取得されるすべてのパスがUnix形式になっていることを確認できます。これにより、どのような環境でも一貫したパス形式でファイルシステムを操作できるようになります。

Copy
1<?php
2
3/**
4 * 指定されたディレクトリとその内容を再帰的に削除します。
5 *
6 * @param string $dirPath 削除するディレクトリのパス
7 * @return bool 成功した場合はtrue、失敗した場合はfalse
8 */
9function deleteDirectoryRecursively(string $dirPath): bool
10{
11    if (!is_dir($dirPath)) {
12        return false;
13    }
14
15    // RecursiveDirectoryIterator を使ってディレクトリの内容をイテレート
16    // FilesystemIterator::SKIP_DOTS で '.' と '..' をスキップ
17    $iterator = new RecursiveDirectoryIterator($dirPath, FilesystemIterator::SKIP_DOTS);
18    // CHILD_FIRST で子要素から先に処理し、ディレクトリは最後に削除
19    $recursiveIterator = new RecursiveIteratorIterator($iterator, RecursiveIteratorIterator::CHILD_FIRST);
20
21    foreach ($recursiveIterator as $file) {
22        if ($file->isDir()) {
23            rmdir($file->getPathname()); // 空のディレクトリを削除
24        } else {
25            unlink($file->getPathname()); // ファイルを削除
26        }
27    }
28    return rmdir($dirPath); // 最後に空になったルートディレクトリを削除
29}
30
31/**
32 * RecursiveDirectoryIterator::UNIX_PATHS 定数の動作を示します。
33 * この定数を使用すると、Windows環境などでもパスがUNIX形式 (スラッシュ区切り) で出力されます。
34 */
35function demonstrateUnixPathsConstant(): void
36{
37    // 一時テストディレクトリを作成
38    $baseDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'php_unix_paths_example_' . uniqid();
39    $subDir = $baseDir . DIRECTORY_SEPARATOR . 'sub_dir';
40
41    // ディレクトリ作成に失敗した場合の処理
42    if (!mkdir($subDir, 0777, true)) {
43        echo "エラー: テストディレクトリ '{$subDir}' の作成に失敗しました。\n";
44        return;
45    }
46
47    // テストファイルを作成
48    file_put_contents($baseDir . DIRECTORY_SEPARATOR . 'file1.txt', 'test content');
49    file_put_contents($subDir . DIRECTORY_SEPARATOR . 'file2.txt', 'test content');
50
51    echo "--- RecursiveDirectoryIterator::UNIX_PATHS の動作デモンストレーション ---\n\n";
52
53    echo "## 1. RecursiveDirectoryIterator::UNIX_PATHS フラグなしの場合\n";
54    echo "   (OSネイティブのパスセパレータが使用されます。Windowsでは'\\\\'、UNIX系では'/'が多い)\n";
55    try {
56        // フラグなしの場合、OSネイティブのパスセパレータが使用される
57        $iterator = new RecursiveDirectoryIterator(
58            $baseDir,
59            FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_PATHNAME
60        );
61        $recursiveIterator = new RecursiveIteratorIterator($iterator);
62
63        foreach ($recursiveIterator as $pathname => $fileInfo) {
64            // getPathname() はOSネイティブ形式のパスを返します
65            echo "   Path: " . $fileInfo->getPathname() . "\n";
66        }
67    } catch (UnexpectedValueException $e) {
68        echo "エラー: " . $e->getMessage() . "\n";
69    }
70    echo "\n";
71
72    echo "## 2. RecursiveDirectoryIterator::UNIX_PATHS フラグありの場合\n";
73    echo "   (UNIX形式のパスセパレータ '/' が強制的に使用されます)\n";
74    try {
75        // RecursiveDirectoryIterator::UNIX_PATHS を指定すると、強制的にUNIX形式のパスセパレータ '/' が使用される
76        $iterator = new RecursiveDirectoryIterator(
77            $baseDir,
78            FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_PATHNAME | RecursiveDirectoryIterator::UNIX_PATHS
79        );
80        $recursiveIterator = new RecursiveIteratorIterator($iterator);
81
82        foreach ($recursiveIterator as $pathname => $fileInfo) {
83            // getPathname() はUNIX形式のパスを返します
84            echo "   Path: " . $fileInfo->getPathname() . "\n";
85        }
86    } catch (UnexpectedValueException $e) {
87        echo "エラー: " . $e->getMessage() . "\n";
88    }
89    echo "\n";
90
91    // テストディレクトリのクリーンアップ
92    if (deleteDirectoryRecursively($baseDir)) {
93        echo "テストディレクトリ '{$baseDir}' をクリーンアップしました。\n";
94    } else {
95        echo "警告: テストディレクトリ '{$baseDir}' のクリーンアップに失敗しました。\n";
96    }
97}
98
99// デモンストレーションを実行
100demonstrateUnixPathsConstant();
101
102?>

このPHPサンプルコードは、RecursiveDirectoryIteratorクラスで使用できるUNIX_PATHS定数の動作を説明しています。この定数は引数を取らず、整数型（int）の値を返すフラグで、ファイルパスの区切り文字（セパレータ）の形式を制御します。

RecursiveDirectoryIteratorは、通常、実行環境のオペレーティングシステム（OS）に応じたネイティブなパスセパレータ（Windowsではバックスラッシュ\、UNIX系ではスラッシュ/）を使ってファイルパスを返します。

しかし、RecursiveDirectoryIteratorのコンストラクタにRecursiveDirectoryIterator::UNIX_PATHS定数を指定すると、パスセパレータがOSに関わらず強制的にUNIX形式のスラッシュ/に統一されます。これは、異なるOS間でパスの扱いを統一したい場合に特に役立ちます。

サンプルコードでは、一時的なテスト環境を作成し、この定数を指定しない場合と指定した場合で、RecursiveDirectoryIteratorが返すファイルパスの形式を比較しています。これにより、定数を使用するとパスがUNIX形式に統一される様子がわかります。デモンストレーション後には、deleteDirectoryRecursively関数で作成した一時ファイルを削除し、環境をクリーンアップします。