WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / PHP

SplFixedArray::offsetGet — ein Element per Index lesen

Lies einen Eintrag mit `offsetGet()` oder `[]` und unterscheide `null` von einem Index außerhalb des gültigen Bereichs oder mit unzulässigem Typ.

Version: PHP 8.3

Syntax

$value = $array->offsetGet($index);
$value = $array[$index];

SplFixedArray::offsetGet ist eine Instanzmethode, die den Wert am angegebenen Index zurückgibt. Der Rückgabetyp ist mixed: Der gespeicherte Wert behält seinen Typ. Dank ArrayAccess liefert ein einfacher Lesezugriff mit $array[$index] dasselbe Ergebnis wie $array->offsetGet($index). Die Klasse gehört zur SPL, die in PHP 8.3 fest eingebaut ist und sich nicht deaktivieren lässt. Verwende in einem benannten Namensraum \SplFixedArray oder importiere SplFixedArray.

Die Indizes beginnen bei null und müssen 0 <= $index && $index < $array->getSize() erfüllen. Beim Lesen eines gültigen Eintrags, dem noch kein Wert zugewiesen wurde, erhältst du null. Ein ausdrücklich gespeichertes null liefert dasselbe Ergebnis. Am Rückgabewert allein lassen sich die Fälle nicht unterscheiden.

In PHP 8.3 löst ein ganzzahliger Index außerhalb des gültigen Bereichs eine RuntimeException aus. Ein unzulässiger Indextyp, etwa beim String 'name', führt zu einem TypeError. Ab PHP 8.4 ist der Bereichsfehler eine OutOfBoundsException, eine Unterklasse von RuntimeException. Vor PHP 8.1 lösten unzulässige Schlüssel eine RuntimeException aus. Prüfe Typ und Bereich von Indizes aus externen Eingaben, statt dich auf implizite Umwandlung zu verlassen: Beim Lesen mit [] kann der String '0' beispielsweise als Index 0 gelten.

Die Methode gibt keine Referenz auf den Eintrag zurück. Um ein verschachteltes PHP-Array zu ändern, lies es in eine Variable ein, ändere es und schreibe es mit $array[$index] = $value oder $array->offsetSet($index, $value) zurück.

Beispiele

<?php
$array = new \SplFixedArray(2);
$array[0] = 42;

var_dump($array->offsetGet(0));
var_dump($array[0]);
var_dump($array->offsetGet(1));

foreach ([2, 'name'] as $index) {
    try {
        $array->offsetGet($index);
    } catch (\RuntimeException | \TypeError $error) {
        echo get_class($error), "\n";
    }
}

Ergebnis

int(42)
int(42)
NULL
RuntimeException
TypeError

Beide Leseformen liefern `int(42)`. Der Eintrag ohne Zuweisung ergibt `NULL`; die letzten beiden Zeilen zeigen die unter PHP 8.3 erwarteten Ausnahmeklassen.

Zugehörige Lektionen

  • PHP · Lektion 66 · Fortgeschritten · Version: 2

Quellen