ArrayAccess::offsetExists

(PHP 5, PHP 7, PHP 8)

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

Описание

publicArrayAccess::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)
To Top