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

Copy
1<?php
2
3/**
4 * GlobIterator::UNIX_PATHS 定数を使用したファイル検索のデモンストレーション。
5 *
6 * この関数は、一時的なディレクトリとファイルを作成し、
7 * GlobIterator を GlobIterator::UNIX_PATHS フラグ付きでインスタンス化して、
8 * UNIXスタイルのパスパターンがどのように機能するかを示します。
9 * Windows環境などでも、パスの区切り文字として常にスラッシュ（/）が使われるため、
10 * UNIXスタイルのパスパターンをそのまま利用できます。
11 */
12function demonstrateGlobIteratorUnixPaths(): void
13{
14    // 一時ディレクトリの基盤パスとユニークな名前を作成
15    $baseTempDir = sys_get_temp_dir();
16    $testDirName = 'glob_unix_paths_test_' . uniqid();
17    $fullTestDir = $baseTempDir . DIRECTORY_SEPARATOR . $testDirName;
18
19    // テスト用のディレクトリとファイル構造を作成
20    // /tmp/glob_unix_paths_test_XXXXXX/
21    // ├── subdir1/
22    // │   └── file1.txt
23    // └── subdir2/
24    //     └── file2.log
25    //     └── another_file.txt
26    try {
27        mkdir($fullTestDir . DIRECTORY_SEPARATOR . 'subdir1', 0777, true);
28        mkdir($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2', 0777, true);
29
30        file_put_contents($fullTestDir . DIRECTORY_SEPARATOR . 'subdir1' . DIRECTORY_SEPARATOR . 'file1.txt', 'Content for file1.txt');
31        file_put_contents($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'file2.log', 'Content for file2.log');
32        file_put_contents($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'another_file.txt', 'Content for another_file.txt');
33
34        echo "--- GlobIterator::UNIX_PATHS デモンストレーション ---" . PHP_EOL;
35        echo "一時ディレクトリを作成しました: " . $fullTestDir . PHP_EOL;
36        echo PHP_EOL;
37
38        // UNIXスタイルのパスパターンを定義。
39        // このパターンは、作成した一時ディレクトリ内の全てのサブディレクトリにある.txtファイルを検索します。
40        // GlobIterator::UNIX_PATHS を使うことで、OSに依存しないスラッシュ区切りでパターンを記述できます。
41        $unixStylePattern = $fullTestDir . '/subdir*/*.txt';
42        echo "検索パターン (UNIXスタイル): " . $unixStylePattern . PHP_EOL;
43        echo "使用フラグ: GlobIterator::UNIX_PATHS" . PHP_EOL;
44        echo PHP_EOL;
45
46        // GlobIterator::UNIX_PATHS フラグを指定して GlobIterator をインスタンス化
47        $iterator = new GlobIterator($unixStylePattern, GlobIterator::UNIX_PATHS);
48
49        if (!$iterator->valid()) {
50            echo "指定されたパターンに一致するファイルは見つかりませんでした。" . PHP_EOL;
51        } else {
52            echo "見つかったファイル:" . PHP_EOL;
53            foreach ($iterator as $fileInfo) {
54                // SplFileInfoオブジェクトからファイルパスを取得して表示
55                echo "- " . $fileInfo->getPathname() . PHP_EOL;
56            }
57        }
58
59    } catch (Throwable $e) {
60        // ファイル操作やGlobIteratorのコンストラクタで発生する可能性のあるエラーを捕捉
61        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
62    } finally {
63        // 後処理: 作成したファイルとディレクトリを削除し、環境をクリーンアップします。
64        echo PHP_EOL;
65        echo "--- クリーンアップ ---" . PHP_EOL;
66        if (is_dir($fullTestDir)) {
67            // ディレクトリ内のファイルを削除
68            if (is_file($fullTestDir . DIRECTORY_SEPARATOR . 'subdir1' . DIRECTORY_SEPARATOR . 'file1.txt')) {
69                unlink($fullTestDir . DIRECTORY_SEPARATOR . 'subdir1' . DIRECTORY_SEPARATOR . 'file1.txt');
70            }
71            if (is_file($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'file2.log')) {
72                unlink($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'file2.log');
73            }
74            if (is_file($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'another_file.txt')) {
75                unlink($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2' . DIRECTORY_SEPARATOR . 'another_file.txt');
76            }
77            // サブディレクトリを削除
78            if (is_dir($fullTestDir . DIRECTORY_SEPARATOR . 'subdir1')) {
79                rmdir($fullTestDir . DIRECTORY_SEPARATOR . 'subdir1');
80            }
81            if (is_dir($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2')) {
82                rmdir($fullTestDir . DIRECTORY_SEPARATOR . 'subdir2');
83            }
84            // ベースディレクトリを削除
85            rmdir($fullTestDir);
86            echo "一時ファイルとディレクトリを削除しました。" . PHP_EOL;
87        } else {
88            echo "クリーンアップする一時ディレクトリが見つかりませんでした。" . PHP_EOL;
89        }
90    }
91}
92
93// スクリプトを実行
94demonstrateGlobIteratorUnixPaths();
95

PHPのGlobIterator::UNIX_PATHSは、ファイルやディレクトリを検索するGlobIteratorクラスで利用する定数です。この定数を使用すると、ファイル検索パターン（グロブパターン）内のパス区切り文字として、オペレーティングシステム（OS）に依存せず、常にUNIXスタイルのスラッシュ（/）が適用されるようになります。この定数自体は引数を取らず、内部的には整数値（int）として扱われます。

通常、Windowsではパス区切りにバックスラッシュ（\）が使われますが、UNIX_PATHSを指定することで、UNIX系OSと同じ/区切りのパターンをWindows環境でもそのまま利用できるようになり、コードの可搬性が高まります。

このサンプルコードは、一時的なディレクトリとファイルを作成し、その中でGlobIterator::UNIX_PATHSフラグを使用してファイル検索を行うデモンストレーションです。'/subdir*/*.txt'といったUNIXスタイルのパターンを指定しても、OSの違いを意識することなく、期待通りに.txtファイルが検索される様子を確認できます。システムエンジニアを目指す方にとって、異なるOS環境で一貫したファイル操作を行う上で非常に重要な概念です。

Copy
1<?php
2
3/**
4 * GlobIterator::UNIX_PATHS 定数の使用例。
5 *
6 * この定数は、Windows環境においてGlobIteratorがパスパターン内のフォワードスラッシュ (/) のみを
7 * パス区切り文字として認識し、バックスラッシュ (\) を通常の文字として扱うように変更します。
8 * システムエンジニアを目指す初心者の方は、Windows環境でUNIX風のパスパターンを使用する際の
9 * パス区切り文字の解釈の違いを理解するのに役立ちます。
10 */
11function demonstrateGlobIteratorUnixPaths(): void
12{
13    // 一時ディレクトリを作成し、テストファイルを配置
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'glob_test_' . uniqid();
15    if (!mkdir($tempDir . DIRECTORY_SEPARATOR . 'data' . DIRECTORY_SEPARATOR . 'subdir_a', 0777, true)) {
16        echo "一時ディレクトリの作成に失敗しました。\n";
17        return;
18    }
19    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'data' . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'file1.txt', 'content');
20    file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'data' . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . 'file2.log', 'content');
21    echo "一時ディレクトリ: $tempDir にテストファイルを配置しました。\n\n";
22
23    // Windowsスタイルのパスパターン（バックスラッシュを含む）を定義
24    // このパターンは、Windows環境では`\`がパス区切り文字として解釈されます。
25    $windowsStylePattern = $tempDir . DIRECTORY_SEPARATOR . 'data' . DIRECTORY_SEPARATOR . 'subdir_a' . DIRECTORY_SEPARATOR . '*.txt';
26    echo "=== シナリオ: Windowsスタイルのパターン '{$windowsStylePattern}' ===\n";
27
28    // 1. GlobIterator を GlobIterator::UNIX_PATHS フラグなしで使用
29    echo "\n--- GlobIterator (UNIX_PATHS フラグなし) ---\n";
30    // 通常のWindows環境では、`\`がパス区切り文字として認識され、ファイルがマッチするはずです。
31    $iteratorNoFlags = new GlobIterator($windowsStylePattern);
32    $resultsNoFlags = iterator_to_array($iteratorNoFlags);
33    if (empty($resultsNoFlags)) {
34        echo "  マッチするファイルはありませんでした。\n";
35    } else {
36        foreach ($resultsNoFlags as $file) {
37            echo "  - " . $file->getPathname() . "\n";
38        }
39    }
40
41    // 2. GlobIterator を GlobIterator::UNIX_PATHS フラグありで使用
42    echo "\n--- GlobIterator (UNIX_PATHS フラグあり) ---\n";
43    // `UNIX_PATHS` を指定すると、`\`はパス区切り文字としてではなく、通常の文字として扱われます。
44    // そのため、このパターンではディレクトリ構造とマッチせず、ファイルが見つからなくなるはずです。
45    $iteratorUnixPaths = new GlobIterator($windowsStylePattern, GlobIterator::UNIX_PATHS);
46    $resultsUnixPaths = iterator_to_array($iteratorUnixPaths);
47    if (empty($resultsUnixPaths)) {
48        echo "  マッチするファイルはありませんでした。（`UNIX_PATHS`により`\`がパス区切り文字として扱われないため）\n";
49    } else {
50        foreach ($resultsUnixPaths as $file) {
51            echo "  - " . $file->getPathname() . "\n";
52        }
53    }
54
55    // 後処理: 一時ディレクトリを削除するヘルパー関数
56    $rmdirRecursive = function (string $dir) use (&$rmdirRecursive): bool {
57        if (!file_exists($dir)) {
58            return true;
59        }
60        $files = array_diff(scandir($dir), ['.', '..']);
61        foreach ($files as $file) {
62            $path = $dir . DIRECTORY_SEPARATOR . $file;
63            (is_dir($path)) ? $rmdirRecursive($path) : unlink($path);
64        }
65        return rmdir($dir);
66    };
67
68    echo "\n一時ディレクトリを削除中...\n";
69    if ($rmdirRecursive($tempDir)) {
70        echo "一時ディレクトリ '$tempDir' を削除しました。\n";
71    } else {
72        echo "一時ディレクトリ '$tempDir' の削除に失敗しました。\n";
73    }
74}
75
76// 関数を実行
77demonstrateGlobIteratorUnixPaths();
78

PHP 8のGlobIterator::UNIX_PATHS定数は、GlobIteratorクラスで使用されるフラグの一つで、int型の値を持ち、引数はありません。この定数は、主にWindows環境において、GlobIteratorがパスパターン内のフォワードスラッシュ（/）のみをパス区切り文字として認識し、バックスラッシュ（\）を通常の文字として扱うように変更します。これにより、UNIX系のシステムと同じパスの解釈挙動を模倣します。

サンプルコードでは、まず一時ディレクトリにテストファイルを配置します。その後、バックスラッシュを含むWindowsスタイルのパスパターンを使用してファイル検索を行います。GlobIterator::UNIX_PATHSフラグなしでGlobIteratorを実行した場合、Windowsの標準的なパス区切り文字であるバックスラッシュが正しく解釈され、ファイルがマッチします。しかし、同じパスパターンに対してGlobIterator::UNIX_PATHSフラグを付けてGlobIteratorを実行すると、バックスラッシュはパス区切り文字ではなく通常の文字として扱われるため、パスパターンがディレクトリ構造と一致せず、ファイルが見つからない結果となります。

この定数は、異なるオペレーティングシステム間でパス区切り文字の解釈が異なる点、特にWindows環境でUNIX風のパスパターンを扱う際の挙動の違いを理解するために重要です。システムエンジニアを目指す初心者の方にとって、クロスプラットフォームなファイル操作やパス処理の際に、この定数の役割を理解することは役立ちます。