KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / PHP

Iterator::key — De sleutel van het huidige element lezen

Lees de sleutel van het huidige element zonder de iterator te verplaatsen en zie hoe PHP die sleutel in een `foreach`-lus toewijst.

Versie: PHP 8.3

Syntax

public function key(): mixed

$iterator->key();

Iterator::key is een publieke instantiemethode zonder parameters. Roep $iterator->key() aan om de sleutel op de huidige positie te lezen zonder de iterator te verplaatsen. current() leest de waarde op diezelfde positie, next() gaat verder en rewind() gaat terug naar het begin.

In foreach ($iterator as $key => $value) roept PHP aan het begin rewind() aan en controleert het vóór elke iteratie valid(). Op een geldige positie leest het de waarde met current() en de sleutel met key(). Na een normale uitvoering van de lusbody roept het next() aan. Controleer bij handmatige iteratie valid() in plaats van de sleutel: 0 kan een geldige sleutel zijn.

Het retourtype mixed beperkt sleutels niet tot int en string: MultipleIterator::key() retourneert bijvoorbeeld een array. ArrayIterator::key() heeft een beperktere signatuur: string|int|null. De handleiding van de interface noemt null en E_NOTICE bij mislukking, maar ga er niet van uit dat elke implementatie zich zo gedraagt op een ongeldige positie. Declareer in PHP 8.3 in je eigen implementatie public function key(): mixed of een compatibel, beperkter retourtype om een deprecatiemelding over de signatuur te voorkomen.

Verwar de methode niet met de globale functie \key($array), die de sleutel teruggeeft van het element waarnaar de interne aanwijzer van de array wijst. Een object doorgeven aan die functie is sinds PHP 8.1 gemarkeerd als verouderd.

Voorbeelden

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

Resultaat

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

Het voorbeeld gebruikt `\ArrayIterator` uit SPL. Beide aanroepen geven `0` terug; `next()` verplaatst de iterator naar `tree`. De `foreach`-lus begint opnieuw bij het begin en toont beide paren.

Gerelateerde lessen

  • PHP · Les 61 · Gevorderd · Versie: 2
  • PHP · Les 63 · Gevorderd · Versie: 2

Bronnen