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

Copy
1<?php
2
3// GlobIterator::getType() メソッドのサンプルコード
4// このメソッドは、GlobIterator が現在反復処理している要素の型（ファイルまたはディレクトリ）を文字列で返します。
5
6/**
7 * テスト用のファイルとディレクトリを作成し、環境をセットアップします。
8 *
9 * @param string $baseDir テスト環境を作成するベースディレクトリのパス。
10 */
11function setupTestEnvironment(string $baseDir): void
12{
13    // ベースディレクトリが存在しない場合は作成
14    if (!is_dir($baseDir)) {
15        mkdir($baseDir, 0777, true);
16    }
17
18    // テスト用のファイルを作成
19    file_put_contents($baseDir . '/sample_file.txt', 'これはテストファイルです。');
20    // テスト用のサブディレクトリを作成
21    mkdir($baseDir . '/sample_dir', 0777, true);
22    file_put_contents($baseDir . '/sample_dir/nested_file.log', 'これはネストされたファイルです。');
23
24    echo "テスト環境をセットアップしました。\n";
25}
26
27/**
28 * 作成したテスト用のファイルとディレクトリを削除し、環境をクリーンアップします。
29 *
30 * @param string $dirPath クリーンアップするディレクトリのパス。
31 */
32function cleanupTestEnvironment(string $dirPath): void
33{
34    // ディレクトリが存在しない場合は何もしない
35    if (!is_dir($dirPath)) {
36        return;
37    }
38
39    // ディレクトリ内の全てのアイテム（ファイルとサブディレクトリ）を削除
40    $items = array_diff(scandir($dirPath), ['.', '..']);
41    foreach ($items as $item) {
42        $itemPath = $dirPath . '/' . $item;
43        if (is_dir($itemPath)) {
44            // サブディレクトリの場合は再帰的にクリーンアップ
45            cleanupTestEnvironment($itemPath);
46        } else {
47            // ファイルの場合は削除
48            unlink($itemPath);
49        }
50    }
51    // 空になったディレクトリを削除
52    rmdir($dirPath);
53
54    echo "テスト環境をクリーンアップしました。\n";
55}
56
57// スクリプトが実行されているディレクトリに一時的なテストディレクトリを作成
58$testBaseDir = __DIR__ . '/_temp_glob_test_';
59
60try {
61    // 1. テスト環境のセットアップ
62    setupTestEnvironment($testBaseDir);
63
64    echo "\n--- GlobIterator::getType() の実行結果 ---\n";
65
66    // 2. GlobIterator を初期化
67    // ワイルドカード '*' を使用して、指定ディレクトリ内の全てのファイルとディレクトリを対象とする
68    // GlobIterator は FilesystemIterator を継承しており、FilesystemIterator::getType() を提供します。
69    $iterator = new GlobIterator($testBaseDir . '/*');
70
71    // 3. イテレータを反復処理し、各アイテムの型を表示
72    foreach ($iterator as $path => $fileInfo) {
73        // getType() メソッドで現在の要素の型（'file' または 'dir'）を取得
74        // ここでの $path はファイルまたはディレクトリのフルパスです。
75        $type = $iterator->getType();
76
77        echo "パス: " . $path . ", 型: " . $type . "\n";
78    }
79
80    echo "--- 実行終了 ---\n\n";
81
82} catch (Exception $e) {
83    // エラーが発生した場合の処理
84    echo "エラーが発生しました: " . $e->getMessage() . "\n";
85} finally {
86    // 4. テスト環境のクリーンアップ（エラーの有無にかかわらず実行）
87    cleanupTestEnvironment($testBaseDir);
88}

PHPのGlobIterator::getType()メソッドは、ファイルシステム内の要素を繰り返し処理するGlobIteratorが、現在アクセスしている要素の型を文字列で取得するために使用されます。このメソッドは引数を必要とせず、現在の要素が「ファイル」であれば'file'、または「ディレクトリ」であれば'dir'という文字列を戻り値として返します。

提供されたサンプルコードでは、まずテスト用のファイルとディレクトリを一時的に作成し、処理の準備をしています。次に、GlobIteratorを初期化して、作成したテストディレクトリ内の全てのファイルとサブディレクトリを対象とします。foreachループを使って各要素を順に処理する際、$iterator->getType()を呼び出すことで、現在処理中の要素がファイルなのかディレクトリなのかを判別し、その型を画面に出力しています。これにより、プログラムでファイルやディレクトリの種類に応じて異なる処理を行いたい場合に、getType()メソッドが非常に役立つことがわかります。処理の完了後には、作成したテスト環境を適切にクリーンアップしています。

Copy
1<?php
2
3/**
4 * GlobIterator::getType() メソッドの使用例を示します。
5 * このメソッドは、GlobIterator が反復処理している現在のファイルシステムオブジェクトのタイプを文字列で返します。
6 * (例: 'file', 'dir', 'link' など)
7 *
8 * @return void
9 */
10function demonstrateGlobIteratorGetType(): void
11{
12    // テスト用のユニークなディレクトリパスを生成します
13    $testDirPath = __DIR__ . DIRECTORY_SEPARATOR . 'temp_glob_test_' . uniqid();
14
15    // テストディレクトリが存在しない場合は作成します
16    if (!is_dir($testDirPath)) {
17        mkdir($testDirPath, 0777, true);
18    }
19
20    // テスト用のファイルとサブディレクトリを作成します
21    file_put_contents($testDirPath . DIRECTORY_SEPARATOR . 'sample_file.txt', 'This is a sample file.');
22    mkdir($testDirPath . DIRECTORY_SEPARATOR . 'sample_subdir');
23
24    echo "--- GlobIterator::getType() デモンストレーション ---\n";
25    echo "対象ディレクトリ: " . $testDirPath . "\n\n";
26
27    try {
28        // GlobIterator を初期化します。
29        // 指定されたパスパターン（ここではテストディレクトリ内の全ての項目）にマッチする
30        // ファイルシステムのエントリを反復処理します。
31        // FilesystemIterator::KEY_AS_PATHNAME は、キーをフルパス名にします。
32        $iterator = new GlobIterator($testDirPath . DIRECTORY_SEPARATOR . '*', FilesystemIterator::KEY_AS_PATHNAME);
33
34        // 各エントリをループ処理し、そのファイルシステムタイプを取得します
35        foreach ($iterator as $pathname => $fileInfo) {
36            echo "パス: " . $pathname . "\n";
37            // getType() メソッドは、現在のファイルシステムオブジェクトのタイプを文字列で返します。
38            // 変数のデータ型（gettype() グローバル関数）とは異なり、
39            // ファイルシステム上のエントリ（ファイル、ディレクトリなど）の種類を示します。
40            echo "タイプ: " . $fileInfo->getType() . "\n";
41            echo "----------------------------------------\n";
42        }
43    } catch (UnexpectedValueException $e) {
44        echo "エラー: 指定されたパスにファイルが見つからないか、アクセスできません: " . $e->getMessage() . "\n";
45    } catch (Exception $e) {
46        echo "予期せぬエラーが発生しました: " . $e->getMessage() . "\n";
47    } finally {
48        // 後処理: 作成したテスト用のファイルとディレクトリを削除します
49        echo "\n--- クリーンアップ中 ---\n";
50        if (is_dir($testDirPath)) {
51            // ディレクトリ内の項目を削除
52            $items = array_diff(scandir($testDirPath), array('.', '..'));
53            foreach ($items as $item) {
54                $itemPath = $testDirPath . DIRECTORY_SEPARATOR . $item;
55                if (is_dir($itemPath)) {
56                    // サブディレクトリの場合
57                    rmdir($itemPath);
58                } else {
59                    // ファイルの場合
60                    unlink($itemPath);
61                }
62            }
63            // 空になった親ディレクトリを削除
64            rmdir($testDirPath);
65            echo "テストディレクトリとファイルは正常に削除されました。\n";
66        }
67    }
68}
69
70// 関数を実行します
71demonstrateGlobIteratorGetType();
72
73?>

PHPのGlobIterator::getType()メソッドは、ファイルシステムを反復処理する際に、現在処理中のファイルシステムオブジェクトがどのような種類であるかを文字列で取得するために利用されます。このメソッドはGlobIteratorクラスに属しており、引数を必要とせず、'file'（通常のファイル）、'dir'（ディレクトリ）、'link'（シンボリックリンク）などの文字列を戻り値として返します。

一般的に変数のデータ型を調べるためのPHPグローバル関数gettype()とは異なり、GlobIterator::getType()はファイルシステム上の「項目」の種類を識別するために用いられる点が特徴です。

サンプルコードでは、まず一時的なテストディレクトリを作成し、その中にテスト用のファイルとサブディレクトリを配置します。その後、GlobIteratorを使ってこのディレクトリ内の全項目を走査し、ループ内で各項目に対してgetType()メソッドを呼び出しています。これにより、各パスが通常のファイルなのかディレクトリなのかといった種類が具体的に出力される様子を確認できます。処理の最後には、作成されたテスト環境が適切にクリーンアップされます。このメソッドは、ファイルシステム内の多様な項目を識別し、それぞれに応じた処理を効率的に実行する際に非常に有用です。

Copy
1<?php
2
3/**
4 * GlobIterator::getType() メソッドの使用例
5 *
6 * このスクリプトは、GlobIterator を使用して指定されたパスパターンに一致する
7 * ファイルやディレクトリを走査し、各項目の種類（ファイルかディレクトリか）を
8 * getType() メソッドで取得・表示する方法を示します。
9 *
10 * システムエンジニアを目指す初心者が、ファイルシステムを扱うイテレータと
11 * その要素の型を判別する方法を理解するのに役立ちます。
12 */
13
14// 一時的なディレクトリとファイルを作成し、GlobIterator が処理する対象を用意します。
15// これにより、スクリプトが単体で動作し、特定の環境に依存しないようになります。
16$testDir = __DIR__ . DIRECTORY_SEPARATOR . 'glob_test_dir_' . uniqid();
17mkdir($testDir);
18file_put_contents($testDir . DIRECTORY_SEPARATOR . 'sample_file.txt', 'This is a sample file.');
19mkdir($testDir . DIRECTORY_SEPARATOR . 'sample_subdir');
20
21echo "--- GlobIterator::getType() サンプル実行 ---" . PHP_EOL;
22
23try {
24    // GlobIterator をインスタンス化します。
25    // 第1引数には、検索したいファイルやディレクトリのパスパターンを指定します。
26    // ここでは、作成した一時ディレクトリ内の全ての項目（'*'）を対象としています。
27    $iterator = new GlobIterator($testDir . DIRECTORY_SEPARATOR . '*');
28
29    // イテレータをループし、パターンに一致した各項目を処理します。
30    foreach ($iterator as $item) {
31        // $item は SplFileInfo オブジェクトであり、getPathname() でフルパスを取得できます。
32        $path = $item->getPathname();
33
34        // getType() メソッドは、現在のイテレータ項目がファイル('file')か
35        // ディレクトリ('dir')かを文字列で返します。
36        // このメソッドは FilesystemIterator クラスから継承されています。
37        $type = $iterator->getType();
38
39        echo "パス: " . $path . ", 種類: " . $type . PHP_EOL;
40    }
41} catch (RuntimeException $e) {
42    // GlobIterator の初期化や操作中にエラーが発生した場合のハンドリング
43    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
44} finally {
45    // テスト用に作成した一時ファイルとディレクトリをクリーンアップします。
46    // ファイルが存在するか確認してから削除することで、エラーを避けます。
47    if (file_exists($testDir . DIRECTORY_SEPARATOR . 'sample_file.txt')) {
48        unlink($testDir . DIRECTORY_SEPARATOR . 'sample_file.txt');
49    }
50    if (file_exists($testDir . DIRECTORY_SEPARATOR . 'sample_subdir')) {
51        rmdir($testDir . DIRECTORY_SEPARATOR . 'sample_subdir');
52    }
53    if (file_exists($testDir)) {
54        rmdir($testDir);
55    }
56    echo "--- サンプル実行完了（クリーンアップ済み） ---" . PHP_EOL;
57}
58
59?>

PHPのGlobIterator::getType()メソッドは、ファイルシステム内を特定のパターンで走査するGlobIteratorオブジェクトが、現在指し示している項目が「ファイル」なのか「ディレクトリ」なのかを判別するために使用されます。このメソッドは引数を必要とせず、呼び出すだけで現在の項目の種類を取得できます。

戻り値は文字列型で、もし現在の項目がファイルであれば'file'、ディレクトリであれば'dir'という値が返されます。システムエンジニアを目指す方にとって、ファイルシステムをプログラムで操作する際、ファイルとディレクトリで処理を分岐させたい場面は多々あります。例えば、指定されたディレクトリ内のファイルだけを処理し、サブディレクトリは対象外とするといったケースです。getType()メソッドを利用することで、イテレータによる走査中に各項目がどちらのタイプであるかを簡単に判別し、それぞれの種類に応じた適切なロジックを適用できるようになります。これにより、柔軟かつ効率的なファイルシステム操作を実現できます。