DirectoryIterator::key

(PHP 5, PHP 7, PHP 8)

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

説明

public DirectoryIterator::key(): mixed

現在の 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 アイテムを返す
DirectoryIterator::next() - 次の DirectoryIterator アイテムに移動する
DirectoryIterator::rewind() - DirectoryIterator を最初に巻き戻す
DirectoryIterator::valid() - 現在の DirectoryIterator の位置が有効なファイルであるかどうかチェックする
Iterator::key() - 現在の要素のキーを返す

関連キーワード: 　DirectoryIterator, アイテム, キー, key, next, パラメータ, バージョン, banana, チェック, 位置