ArrayAccess::offsetExists

(PHP 5, PHP 7, PHP 8)

ArrayAccess::offsetExistsОпределяет, существует ли заданное смещение (ключ)

Описание

public ArrayAccess::offsetExists(mixed $offset): bool

Определяет, существует или нет данное смещение (ключ).

Данный метод выполняется при использовании isset() или empty() на объектах, реализующих интерфейс ArrayAccess.

Замечание:

При использовании функции empty(), вызывается метод ArrayAccess::offsetGet() и проверка на пустоту произойдёт, только если метод ArrayAccess::offsetExists() вернёт true.

Список параметров

offset

Смещение (ключ) для проверки.

Возвращаемые значения

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Замечание:

Возвращаемое значение будет приведено к логическому типу (bool), если возвращаемое значение не является логическим.

Примеры

Пример #1 Пример использования метода 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
"Выполняется obj::offsetExists()\n";
var_dump(isset($obj["foobar"]));

echo
"\nВыполняется obj::offsetExists() и obj::offsetGet()\n";
var_dump(empty($obj["foobar"]));

echo
"\nВыполняется obj::offsetExists(), но *не* obj:offsetGet(), поскольку нечего возвращать\n";
var_dump(empty($obj["foobaz"]));
?>

Вывод приведённого примера будет похож на:

Выполняется obj::offsetExists()
string(17) "obj::offsetExists"
bool(true)

Выполняется obj::offsetExists() и obj::offsetGet()
string(17) "obj::offsetExists"
string(14) "obj::offsetGet"
bool(false)

Выполняется obj::offsetExists(), но *не* obj:offsetGet(), поскольку нечего возвращать
string(17) "obj::offsetExists"
bool(true)

Добавить

Примечания пользователей 1 note

up
0
pierstoval at gmail dot com
17 days ago
Please note something:

The docs explain clearly that this method is called when "isset()" or "empty()" are called on the object's key.

This means that there is a huge difference in your custom implementation when you have an internal array on which you choose to call either "isset()" or "array_key_exists()".

Even though the method says "offsetExists", it is *not* supposed to be used only when the offset exists, because this is not at all the behavior of neither "isset" nor "empty" internally.

This means you can have issues like this (more explanations below):

<?php

class Value {
public function
__construct(
public
string $value,
) {
}
}

class
MyArray implements ArrayAccess {
private array
$internal = [];

public function
offsetExists(mixed $offset): bool
{
return
array_key_exists($offset, $this->internal);
}

// ... rest of the implementation
public function offsetGet(mixed $offset): mixed
{
return
$this->offsetExists($offset) ? $this->internal[$offset] : null;
}

public function
offsetSet(mixed $offset, mixed $value): void
{
if (
is_null($offset)) {
$this->internal[] = $value;
} else {
$this->internal[$offset] = $value;
}
}

public function
offsetUnset(mixed $offset): void
{
unset(
$this->internal[$offset]);
}
}

$object = new MyArray();
$object['key'] = null;

// This is where the error occurs:
// PHP Fatal error: Uncaught TypeError: Value::__construct(): Argument #1 ($value) must be of type string, null given
$otherValue = isset($object['key']) ? new Value($object['key']) : null;
?>

The thing here is that we have some code that cannot use the "??" operator because we need the output of the "isset" call to return true, and only then we want to use.

With a real array, this should be fairly common because we know how "isset" works.

However, since the "offsetExists" method has a lot of different implementations in PHP libaries, you should *not* trust the output in "isset" with objects implementing ArrayAccess.

A workaround is to create an intermediate variable and run "isset()" on it:

<?php

// Before
$otherValue = isset($arrayObject['key']) ? new Value($arrayObject['key']) : null;

// After
$rawValue = $arrayObject['key'] ?? null;
$otherValue = isset($rawValue) ? new Value($rawValue) : null;

?>
To Top