reset

    (PHP 4, PHP 5, PHP 7, PHP 8)

    reset — Setzt den internen Zeiger eines Arrays auf sein erstes Element

    Beschreibung

    reset(array|object&$array): mixed

    reset() setzt den internen Zeiger von array auf das erste Element zurück und gibt den Wert des ersten Arrayelements zurück.

    Parameter-Liste

    array

    Das Eingabe-Array.

    Rückgabewerte

    Gibt das erste Element des Arrays zurück oder false wenn das Array leer ist.

    Warnung

    Diese Funktion kann sowohl das boolsche false zurückliefern, als auch einen nicht-boolschen Wert, welcher zu false ausgewertet wird. Weitere Informationen entnehmen Sie bitte dem Abschnitt über die boolschen Typen. Benutzen Sie deshalb den === Operator, um den Rückgabewert dieser Funktion zu überprüfen.

    Changelog

    VersionBeschreibung
    8.1.0 Bei Objekten ist die Verwendung dieser Funktion veraltet. Stattdessen sollte entweder das Objekt vorher mit get_mangled_object_vars() in ein Array umgewandelt werden oder es sollten die Methoden einer Klasse verwendet werden, die Iterator implementiert, z. B. ArrayIterator.
    7.4.0 Instanzen von SPL-Klassen werden nun wie leere Objekte behandelt, die keine Eigenschaften haben, anstatt die Iterator-Methode aufzurufen, die den gleichen Namen wie diese Funktion hat.

    Beispiele

    Beispiel #1 reset()-Beispiel

    <?php

    $array     = array('step one', 'step two', 'step three', 'step four');

    // normalerweise steht der interne Zeiger auf dem ersten Element
    echo current($array) . "<br />\n"; // "step one"

    // Zwei Elemente überspringen
    next($array);
    next($array);
    echo     current($array) . "<br />\n"; // "step three"

    // Zeiger zurücksetzen auf das erste Element und wieder bei step one beginnen
    reset($array);
    echo     current($array) . "<br />\n"; // "step one"

    ?>

    Anmerkungen

    Hinweis: Der Rückgabewert für ein leeres Array ist nicht zu unterscheiden vom Rückgabewert eines Arrays, das ein boolfalse als erstes Element hat. Um den Wert des ersten Elements eines Arrays ordnungsgemäß zu prüfen, das false-Elemente enthalten kann, ist zunächst der count() des Arrays zu prüfen oder sicherzustellen, dass key() nicht null ist, nachdem reset() aufgerufen wurde.

    Siehe auch

    • current() - Liefert das aktuelle Element eines Arrays
    • each() - Liefert das aktuelle Schlüssel-Wert-Paar eines Arrays und rückt den Arrayzeiger vor
    • end() - Positioniert den internen Zeiger eines Arrays auf dessen letztes Element
    • next() - Rückt den internen Arrayzeiger vor
    • prev() - Setzt den internen Arrayzeiger um ein Element zurück
    • array_key_first() - Ermittelt den ersten Schlüssel eines Arrays
    To Top