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

Copy
1<?php
2
3/**
4 * DirectoryIterator::seek メソッドの使用例を示します。
5 * この関数は、一時ディレクトリを作成し、テストファイルを追加し、
6 * DirectoryIterator を使用して特定のオフセットにシークする方法をデモンストレーションします。
7 *
8 * DirectoryIterator クラスは SeekableIterator インターフェースを実装しており、
9 * これにより seek() メソッドを使って指定したオフセットに移動できます。
10 */
11function demonstrateDirectoryIteratorSeek(): void
12{
13    // 1. テスト用の作業ディレクトリを準備します。
14    $tempDir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'seek_demo_' . uniqid();
15    if (!mkdir($tempDir, 0777, true) && !is_dir($tempDir)) {
16        echo "エラー: 一時ディレクトリ '$tempDir' の作成に失敗しました。\n";
17        return;
18    }
19
20    // 2. テスト用のファイルをいくつか作成します。
21    $files = ['alpha.txt', 'beta.txt', 'gamma.txt', 'delta.txt'];
22    foreach ($files as $file) {
23        file_put_contents($tempDir . DIRECTORY_SEPARATOR . $file, "Content of {$file}");
24    }
25    echo "一時ディレクトリ '$tempDir' にテストファイルを作成しました。\n";
26
27    try {
28        // 3. DirectoryIterator をインスタンス化します。
29        $iterator = new DirectoryIterator($tempDir);
30
31        // DirectoryIterator は、最初のエントリとして '.' (カレントディレクトリ) と
32        // 次のエントリとして '..' (親ディレクトリ) を含みます。
33        // そのため、作成した最初のファイルは通常、オフセット 2 から始まります。
34        //
35        // 例: オフセットの順序 (一般的なファイルシステムの場合)
36        // 0: '.'
37        // 1: '..'
38        // 2: 'alpha.txt' (ソート順で最初のファイル)
39        // 3: 'beta.txt'  (ソート順で2番目のファイル)
40        // 4: 'delta.txt' (ソート順で3番目のファイル、ソート順はOSに依存)
41        // 5: 'gamma.txt' (ソート順で4番目のファイル、ソート順はOSに依存)
42
43        // 4. 特定のオフセットにシークします。
44        // ここでは、オフセット 3 の要素にシークしてみます。
45        // これは、ディレクトリ内の3番目の要素（'.'と'..'を含めて）に相当します。
46        $offsetToSeek = 3;
47        echo "\nオフセット {$offsetToSeek} にシークします...\n";
48        $iterator->seek($offsetToSeek);
49
50        // 5. シーク後、現在の要素のファイル名を表示します。
51        // seek() メソッドは戻り値がないため、シーク後に現在の要素にアクセスするには
52        // current() や getFilename() を使用します。
53        if ($iterator->valid()) {
54            echo "シーク後の現在の要素 (ファイル名): " . $iterator->getFilename() . "\n";
55        } else {
56            echo "オフセット {$offsetToSeek} は存在しない位置です。\n";
57        }
58
59        // 別のオフセットにシークして、さらに別のファイルにアクセスする例
60        $anotherOffset = 5; // 例えば、5番目の要素にシーク
61        echo "\nオフセット {$anotherOffset} にシークします...\n";
62        $iterator->seek($anotherOffset);
63        if ($iterator->valid()) {
64            echo "シーク後の現在の要素 (ファイル名): " . $iterator->getFilename() . "\n";
65        } else {
66            echo "オフセット {$anotherOffset} は存在しない位置です。\n";
67        }
68
69    } catch (UnexpectedValueException $e) {
70        echo "エラー: ディレクトリが無効です。 " . $e->getMessage() . "\n";
71    } finally {
72        // 6. 後片付け: 作成したファイルとディレクトリを削除します。
73        echo "\n後片付けを開始します...\n";
74        foreach ($files as $file) {
75            $filePath = $tempDir . DIRECTORY_SEPARATOR . $file;
76            if (file_exists($filePath)) {
77                unlink($filePath);
78            }
79        }
80        if (is_dir($tempDir)) {
81            rmdir($tempDir);
82        }
83        echo "一時ディレクトリ '$tempDir' とファイルが削除されました。\n";
84    }
85}
86
87// 関数を実行します。
88demonstrateDirectoryIteratorSeek();

PHPのDirectoryIterator::seekメソッドは、ディレクトリ内の要素を順番に処理する際に、指定した位置（オフセット）へ直接移動するために利用されます。DirectoryIteratorクラスはSeekableIteratorインターフェースを実装しており、これにより反復処理中の任意の位置に「シーク（移動）」する機能が提供されます。

このメソッドはint $offsetという整数値の引数を受け取ります。この$offsetは、ディレクトリ内の何番目の要素に移動したいかを指定します。DirectoryIteratorは通常、最初のエントリとしてカレントディレクトリを表す「.」と、親ディレクトリを表す「..」を含みます。そのため、ユーザーが作成した最初のファイルは、多くの場合オフセット2から始まります。

seekメソッドは戻り値を持ちません。つまり、このメソッドを実行しても、移動後の要素自体は返されません。シークが成功した後、現在の要素にアクセスするには、$iterator->current()や$iterator->getFilename()といった別のメソッドを使用する必要があります。

サンプルコードでは、一時ディレクトリを作成してテストファイルを配置した後、DirectoryIteratorをインスタンス化しています。そして、seek()メソッドを使って特定のオフセットに移動し、その位置にある要素のファイル名を表示しています。これにより、seekメソッドで任意の要素へ移動できることを示しています。最後に、作成した一時ディレクトリとファイルを削除し、後片付けを行っています。

Copy
1<?php
2
3/**
4 * DirectoryIterator::seek メソッドを使用して、ディレクトリ内の最後の項目にアクセスするサンプルコードです。
5 * キーワード "php seek_end" に対応するため、最初に項目数を数え、そのインデックスを使用して末尾に移動します。
6 */
7
8// 一時ディレクトリを作成し、サンプルファイルを追加して、コードが単体で動作するようにします。
9$tempDir = __DIR__ . DIRECTORY_SEPARATOR . 'temp_seek_dir';
10if (!is_dir($tempDir)) {
11    mkdir($tempDir);
12}
13// 識別しやすいようにファイル名にアルファベット順になるようなサフィックスを付けます。
14file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file_a.txt', 'Content A');
15file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file_b.txt', 'Content B');
16file_put_contents($tempDir . DIRECTORY_SEPARATOR . 'file_c.txt', 'Content C');
17
18try {
19    // DirectoryIterator オブジェクトを作成します。
20    // これにより、指定したディレクトリ内の項目をイテレート（順に処理）できるようになります。
21    $iterator = new DirectoryIterator($tempDir);
22
23    // iterator_count() を使用して、ディレクトリ内の全項目数を取得します。
24    // この関数を呼び出すと、イテレータは内部的にディレクトリの末尾まで進みます。
25    // '. (カレントディレクトリ)' と '.. (親ディレクトリ)' も項目として数えられます。
26    $itemCount = iterator_count($iterator);
27
28    // ディレクトリが空でないことを確認し、最後の項目にアクセスします。
29    if ($itemCount > 0) {
30        // 項目数は0から始まるインデックスなので、最後の項目のインデックスは itemCount - 1 です。
31        $lastItemOffset = $itemCount - 1;
32
33        // DirectoryIterator::seek() メソッドを使用して、イテレータのポインタを指定されたオフセットに移動させます。
34        // ここでは、計算した最後の項目の位置に移動します。
35        $iterator->seek($lastItemOffset);
36
37        // 現在イテレータが指している項目（この場合は最後の項目）の名前を表示します。
38        echo "ディレクトリ内の最後の項目: " . $iterator->getFilename() . PHP_EOL;
39    } else {
40        echo "指定されたディレクトリは空です。" . PHP_EOL;
41    }
42
43} catch (UnexpectedValueException $e) {
44    // 指定されたパスがディレクトリでない場合や、存在しない場合に発生するエラーを処理します。
45    echo "エラー: ディレクトリが見つからないか、アクセスできません。" . PHP_EOL;
46} finally {
47    // 後処理: サンプルコードの実行後に作成した一時ファイルとディレクトリを削除し、クリーンアップします。
48    if (is_dir($tempDir)) {
49        foreach (new DirectoryIterator($tempDir) as $fileInfo) {
50            // '.' と '..' は特別なディレクトリであり、削除しないようにスキップします。
51            if ($fileInfo->isDot()) {
52                continue;
53            }
54            unlink($fileInfo->getPathname()); // ファイルを削除します。
55        }
56        rmdir($tempDir); // 空になったディレクトリを削除します。
57    }
58}

PHPのDirectoryIterator::seekメソッドは、ディレクトリ内の項目を順に処理するイテレータにおいて、現在の処理対象（ポインタ）を特定のインデックス（位置）へ移動するために使用されます。引数int $offsetには、移動したい項目の0から始まるインデックスを指定します。このメソッドはイテレータのポインタを移動させる操作を行うため、戻り値はありません。

このサンプルコードは、「php seek_end」というキーワードに対応し、seekメソッドを使ってディレクトリ内の最後の項目にアクセスする方法を示しています。まず、コードが単体で動作するよう、一時ディレクトリとサンプルファイルを準備します。

DirectoryIteratorオブジェクトを作成した後、iterator_count()関数を使ってディレクトリ内の全項目数を取得します。この際、イテレータは内部的にディレクトリの末尾まで進み、.（カレントディレクトリ）と..（親ディレクトリ）も項目として数えられます。取得した項目数から1を引くことで、最後の項目のインデックスを計算します。その後、$iterator->seek($lastItemOffset)を呼び出し、イテレータの現在の位置を計算した最後の項目に移動させます。最後にgetFilename()で、イテレータが指す現在の項目、すなわちディレクトリ内の最後のファイル名を取得し、画面に表示しています。これにより、ディレクトリの任意の場所へ効率的にアクセスできることを示しています。