Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / PHP

Iterator::key — Leggere la chiave dell’elemento corrente

Leggi la chiave dell’elemento corrente senza far avanzare l’iteratore e scopri come PHP la assegna in un ciclo `foreach`.

Versione: PHP 8.3

Sintassi

public function key(): mixed

$iterator->key();

Iterator::key è un metodo pubblico di istanza senza parametri. Chiama $iterator->key() per leggere la chiave nella posizione corrente senza spostare l’iteratore. current() legge il valore nella stessa posizione, next() avanza e rewind() torna all’inizio.

In foreach ($iterator as $key => $value), PHP chiama rewind() all’inizio e controlla valid() prima di ogni iterazione. In una posizione valida legge il valore con current() e la chiave con key(). Dopo un normale passaggio nel corpo del ciclo, chiama next(). Se percorri l’iteratore manualmente, controlla valid() invece di valutare la chiave: 0 può essere una chiave valida.

Il tipo restituito mixed non limita le chiavi a int e string: ad esempio, MultipleIterator::key() restituisce un array. ArrayIterator::key() ha una firma più restrittiva: string|int|null. Il manuale dell’interfaccia indica null ed E_NOTICE in caso di errore, ma non dare per scontato che tutte le implementazioni si comportino così in una posizione non valida. In PHP 8.3, dichiara public function key(): mixed o un tipo restituito compatibile più restrittivo nella tua implementazione per evitare un avviso di deprecazione relativo alla firma.

Non confondere il metodo con la funzione globale \key($array), che restituisce la chiave dell’elemento indicato dal puntatore interno dell’array. Passare un oggetto a tale funzione è deprecato da PHP 8.1.

Esempi

<?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";
}

Risultato

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

L’esempio usa `\ArrayIterator` di SPL. Entrambe le letture restituiscono `0`; `next()` sposta l’iteratore su `tree`. Il ciclo `foreach` riparte dall’inizio e stampa entrambe le coppie.

Lezioni correlate

  • PHP · Lezione 61 · Avanzato · Versione: 2
  • PHP · Lezione 63 · Avanzato · Versione: 2

Fonti