ArrayAccess::offsetExists

(PHP 5, PHP 7, PHP 8)

ArrayAccess::offsetExists — Comprobar si existe un índice

Descripción

publicArrayAccess::offsetExists(mixed$offset): bool

Comprueba si existe o no un índice.

Este método se ejecuta cuando se utilizan las funciones isset() o empty() sobre los objetos que implementan ArrayAccess.

Nota:
Cuando se utiliza empty(), ArrayAccess::offsetGet() será invocada para comprobar si está vacío solamente si ArrayAccess::offsetExists() devuelve true.

Parámetros

offset: El índice a comprobar.

Valores devueltos

Devuelve true en caso de éxito o false en caso de error.

Nota:
El valor de retorno se debe convertir a bool si no devuelve un valor boleano.

Ejemplos

Ejemplo #1 Ejemplo de ArrayAccess::offsetExists()

<?php
class obj implements ArrayAccess {
 public function offsetSet($offset, $value): void {
var_dump(__METHOD__);
 }
 public function offsetExists($var): bool {
var_dump(__METHOD__);
 if ($var == "foobar") {
 return true;
 }
 return false;
 }
 public function offsetUnset($var): void {
var_dump(__METHOD__);
 }
 #[\ReturnTypeWillChange]
 public function offsetGet($var) {
var_dump(__METHOD__);
 return "value";
 }
}

$obj = new obj;

echo "Runs obj::offsetExists()\n";
var_dump(isset($obj["foobar"]));

echo "\nRuns obj::offsetExists() and obj::offsetGet()\n";
var_dump(empty($obj["foobar"]));

echo "\nRuns obj::offsetExists(), *not* obj:offsetGet() as there is nothing to get\n";
var_dump(empty($obj["foobaz"]));
?>

El resultado del ejemplo sería algo similar a:

Runs obj::offsetExists() string(17) "obj::offsetExists" bool(true) Runs obj::offsetExists() and obj::offsetGet() string(17) "obj::offsetExists" string(14) "obj::offsetGet" bool(false) Runs obj::offsetExists(), *not* obj:offsetGet() as there is nothing to get string(17) "obj::offsetExists" bool(true)