WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

Iterator::key — Schlüssel des aktuellen Elements

Lies den Schlüssel des aktuellen Elements, ohne den Iterator weiterzuschalten, und sieh, wie `foreach` diesen Schlüssel zuweist.

Version: PHP 8.3

Syntax

public function key(): mixed

$iterator->key();

Iterator::key ist eine öffentliche Instanzmethode ohne Parameter. Mit $iterator->key() liest du den Schlüssel an der aktuellen Position, ohne den Iterator zu verschieben. current() liest dort den Wert, next() geht weiter und rewind() setzt den Iterator an den Anfang zurück.

Bei foreach ($iterator as $key => $value) ruft PHP zuerst rewind() auf und prüft vor jedem Durchlauf valid(). An einer gültigen Position liest es den Wert mit current() und den Schlüssel mit key(). Nach einem normalen Durchlauf des Schleifenrumpfs ruft es next() auf. Prüfe bei manueller Iteration valid() statt des Schlüssels: 0 kann ein gültiger Schlüssel sein.

Der Rückgabetyp mixed beschränkt Schlüssel nicht auf int und string: MultipleIterator::key() liefert zum Beispiel ein Array. ArrayIterator::key() hat die engere Signatur string|int|null. Das Handbuch zur Schnittstelle nennt für einen Fehlschlag null und E_NOTICE; nicht jede Implementierung verhält sich an einer ungültigen Position so. Deklariere in PHP 8.3 in deiner eigenen Implementierung public function key(): mixed oder einen kompatiblen engeren Rückgabetyp, um eine Deprecation-Meldung zur Signatur zu vermeiden.

Verwechsle die Methode nicht mit der globalen Funktion \key($array), die den Schlüssel des Elements zurückgibt, auf das der interne Zeiger des Arrays zeigt. Seit PHP 8.1 ist es veraltet, dieser Funktion ein Objekt zu übergeben.

Beispiele

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

Ergebnis

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

Das Beispiel verwendet `\ArrayIterator` aus der SPL. Beide Abfragen ergeben `0`; erst `next()` wechselt zu `tree`. Die `foreach`-Schleife beginnt von vorn und gibt beide Paare aus.

Zugehörige Lektionen

  • PHP · Lektion 61 · Fortgeschritten · Version: 2
  • PHP · Lektion 63 · Fortgeschritten · Version: 2

Quellen