CKTIS / PHP
SplFixedArray::offsetGet — leer un elemento por índice
Lee una posición con `offsetGet()` o `[]` y distingue un valor `null` de un índice fuera de rango o de un tipo de índice no admitido.
Versión: PHP 8.3
Sintaxis
$value = $array->offsetGet($index);
$value = $array[$index];SplFixedArray::offsetGet es un método de instancia que devuelve el valor del índice solicitado. El tipo de retorno es mixed: el valor conserva el tipo con el que se almacenó. Gracias a ArrayAccess, una lectura normal con $array[$index] da el mismo resultado que $array->offsetGet($index). La clase pertenece a SPL, que está integrada en PHP 8.3 y no se puede desactivar. Dentro de un espacio de nombres, usa \SplFixedArray o importa SplFixedArray.
Los índices empiezan en cero y deben cumplir 0 <= $index && $index < $array->getSize(). Leer una posición válida a la que nunca se ha asignado un valor devuelve null. Leer un null almacenado de forma explícita da el mismo resultado. El valor de retorno por sí solo no permite distinguir los dos casos.
En PHP 8.3, un índice entero fuera de rango lanza RuntimeException; un tipo de índice no admitido, como el de la cadena 'name', lanza TypeError. A partir de PHP 8.4, el error de rango es OutOfBoundsException, una subclase de RuntimeException. Antes de PHP 8.1, las claves no admitidas provocaban RuntimeException. Valida el tipo y el rango de los índices que provengan de entradas externas en vez de depender de la conversión implícita: por ejemplo, una lectura con [] puede tratar la cadena '0' como el índice 0.
El método no devuelve una referencia a la posición. Para cambiar un array de PHP anidado, léelo en una variable, modifícalo y vuelve a guardarlo con $array[$index] = $value o $array->offsetSet($index, $value).
Ejemplos
<?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";
}
}
Resultado
int(42) int(42) NULL RuntimeException TypeError
Las dos formas de lectura devuelven `int(42)`. La posición sin asignar da `NULL` y las dos últimas líneas muestran las clases de excepción esperadas en PHP 8.3.
Lecciones relacionadas
- PHP · Lección 66 · Avanzado · Versión: 2