DirectoryIterator::key
PHP Manual
PHP Manual»DirectoryIterator»DirectoryIterator::key

DirectoryIterator::key

(PHP 5, PHP 7, PHP 8)

DirectoryIterator::keyReturn the key for the current DirectoryIterator item

Beschreibung

public function DirectoryIterator::key(): mixed

Get the key for the current DirectoryIterator item.

Parameter-Liste

Diese Funktion besitzt keine Parameter.

Rückgabewerte

The key for the current DirectoryIterator item as an int.

Changelog

Version Beschreibung
8.1.0 When the iterator is uninitialized, an Error is thrown now. Previously, the method returned false.

Beispiele

Beispiel #1 A DirectoryIterator::key() example

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

Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

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

Siehe auch

To Top