【PHP8.x】seekメソッドの使い方

seekメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

seekメソッドは、FilesystemIteratorオブジェクトがファイルシステム上の要素を繰り返し処理する際に、現在注目している位置(内部的なカーソル)を移動させるメソッドです。このメソッドを使用すると、イテレータが扱っているファイルやディレクトリのリストの中から、特定の順番に位置する要素に直接アクセスできるようになります。具体的には、引数として0から始まる整数値(インデックス)を指定することで、イテレータは指定されたインデックスに対応するファイルまたはディレクトリに自身の位置を移動させます。例えば、ディレクトリ内のたくさんのファイルの中から、先頭から数えて10番目のファイルに直接移動してその情報を取得したい場合などに便利です。この機能により、リストの最初から順にすべての要素をたどる必要がなくなり、特定の要素に素早くアクセスして処理を行うことが可能になります。もし指定したインデックスが有効な範囲外であったり、該当する要素が存在しなかったりする場合には、エラーが発生する可能性がありますので注意が必要です。

構文(syntax)

1<?php
2$iterator = new FilesystemIterator('/tmp');
3
4$iterator->seek(0);
5echo $iterator->getFilename();
6?>

引数(parameters)

int $offset

  • int $offset: 移動したい位置を整数で指定します

戻り値(return)

戻り値なし

戻り値はありません