DirectoryIterator::key

(PHP 5, PHP 7, PHP 8)

DirectoryIterator::key — Retorna a chave para o item atual do DirectoryIterator

Descrição

public DirectoryIterator::key(): mixed

Obtém a chave para o item atual do DirectoryIterator.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

A chave para o item atual do DirectoryIterator como um int.

Registro de Alterações

Versão Descrição

8.1.0 Quando o iterador não está inicializado, agora é lançado um Error. Anteriormente, o método retornava false.

Versão	Descrição
8.1.0	Quando o iterador não está inicializado, agora é lançado um Error. Anteriormente, o método retornava `false`.

Exemplos

Exemplo #1 Um exemplo de DirectoryIterator::key()

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

O exemplo acima produzirá algo semelhante a:

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

Veja Também

DirectoryIterator::current() - Retorna o item atual do DirectoryIterator
DirectoryIterator::next() - Mover para o próximo item do DirectoryIterator
DirectoryIterator::rewind() - Rebobina o DirectoryIterator de volta ao início
DirectoryIterator::valid() - Verifica se a posição atual do DirectoryIterator é um arquivo válido
Iterator::key() - Retorna a chave do elemento atual