DirectoryIterator
PHP マニュアル

DirectoryIterator::key

現在の DirectoryIterator アイテムのキーを返す

説明

public mixed DirectoryIterator::key()

現在の DirectoryIterator アイテムのキーを取得します。

パラメータ

この関数にはパラメータはありません。

戻り値

現在の DirectoryIterator アイテムのキーを数値で返します。

変更履歴

バージョン 説明
8.1.0 イテレーターが初期化されていない場合、 Error がスローされるようになりました。 これより前のバージョンでは、false を返していました。

例

例1 DirectoryIterator::key の例

<?php
$dir = new DirectoryIterator(dirname(__FILE__));
foreach ($dir as $fileinfo) {
    if (!$fileinfo->isDot()) {
        echo $fileinfo->key() . " => " . $fileinfo->getFilename() . "\n";
    }
}
?>

上の例の出力は、 たとえば以下のようになります。

0 => apple.jpg
1 => banana.jpg
2 => index.php
3 => pear.jpg

参考

  • DirectoryIterator::current
  • DirectoryIterator::next
  • DirectoryIterator::rewind
  • DirectoryIterator::valid
  • Iterator::key