Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / PHP

Iterator::key — Leer la clave del elemento actual

Lee la clave del elemento actual sin avanzar el iterador y descubre cómo PHP asigna esa clave en un bucle `foreach`.

Versión: PHP 8.3

Sintaxis

public function key(): mixed

$iterator->key();

Iterator::key es un método público de instancia sin parámetros. Llama a $iterator->key() para leer la clave de la posición actual sin mover el iterador. current() lee el valor en esa misma posición, next() avanza y rewind() vuelve al principio.

En foreach ($iterator as $key => $value), PHP llama a rewind() al inicio y comprueba valid() antes de cada iteración. Si la posición es válida, lee el valor con current() y la clave con key(). Tras una ejecución normal del cuerpo del bucle, llama a next(). Al recorrer el iterador manualmente, comprueba valid() en lugar de evaluar la clave: 0 puede ser una clave válida.

El tipo de retorno mixed no limita las claves a int y string: por ejemplo, MultipleIterator::key() devuelve un array. ArrayIterator::key() tiene una firma más restrictiva: string|int|null. El manual de la interfaz indica null y E_NOTICE en caso de fallo, pero no des por hecho que todas las implementaciones se comporten así en una posición no válida. En PHP 8.3, declara public function key(): mixed o un tipo de retorno compatible más restrictivo en tu implementación para evitar un aviso de obsolescencia relacionado con la firma.

No confundas este método con la función global \key($array), que devuelve la clave del elemento al que apunta el puntero interno del array. Pasar un objeto a esa función está obsoleto desde PHP 8.1.

Ejemplos

<?php
$iterator = new \ArrayIterator([0 => 'oak', 'tree' => 'pine']);

$iterator->rewind();
if ($iterator->valid()) {
    echo $iterator->key(), ', ', $iterator->key(), "\n";
}

$iterator->next();
if ($iterator->valid()) {
    echo $iterator->key(), "\n";
}

foreach ($iterator as $key => $value) {
    echo $key, ' => ', $value, "\n";
}

Resultado

0, 0
tree
0 => oak
tree => pine

El ejemplo usa `\ArrayIterator` de SPL. Ambas lecturas devuelven `0`; `next()` mueve el iterador hasta `tree`. El bucle `foreach` vuelve al principio y muestra los dos pares.

Lecciones relacionadas

  • PHP · Lección 61 · Avanzado · Versión: 2
  • PHP · Lección 63 · Avanzado · Versión: 2

Fuentes