Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / PHP

SplFixedArray::offsetGet — lire un élément par son indice

Lisez une case avec `offsetGet()` ou `[]` et distinguez une valeur `null` d’un indice hors limites ou d’un type d’indice non accepté.

Version : PHP 8.3

Syntaxe

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

SplFixedArray::offsetGet est une méthode d’instance qui renvoie la valeur à l’indice demandé. Le type de retour est mixed : la valeur conserve son type d’origine. Grâce à ArrayAccess, une lecture simple avec $array[$index] donne le même résultat que $array->offsetGet($index). La classe fait partie de SPL, qui est intégrée à PHP 8.3 et ne peut pas être désactivée. Dans un espace de noms nommé, utilisez \SplFixedArray ou importez SplFixedArray.

Les indices commencent à zéro et doivent vérifier 0 <= $index && $index < $array->getSize(). La lecture d’une case valide à laquelle aucune valeur n’a été affectée renvoie null. La lecture d’un null stocké explicitement donne le même résultat. La valeur de retour seule ne permet pas de distinguer ces deux cas.

En PHP 8.3, un indice entier hors limites déclenche RuntimeException ; un type d’indice non accepté, comme celui de la chaîne 'name', déclenche TypeError. À partir de PHP 8.4, le dépassement des limites déclenche OutOfBoundsException, une sous-classe de RuntimeException. Avant PHP 8.1, les clés non acceptées déclenchaient RuntimeException. Vérifiez le type et les limites des indices issus d’entrées externes plutôt que de compter sur la conversion implicite : lors d’une lecture avec [], la chaîne '0' peut par exemple être traitée comme l’indice 0.

La méthode ne renvoie pas de référence à la case. Pour modifier un tableau PHP imbriqué, lisez-le dans une variable, modifiez-le, puis réécrivez-le avec $array[$index] = $value ou $array->offsetSet($index, $value).

Exemples

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

Résultat

int(42)
int(42)
NULL
RuntimeException
TypeError

Les deux formes de lecture renvoient `int(42)`. La case sans affectation donne `NULL`, et les deux dernières lignes indiquent les classes d’exception attendues sous PHP 8.3.

Leçons associées

  • PHP · Leçon 66 · Avancé · Version : 2

Sources