array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'ds-map.remove.php', 1 => 'Ds\\Map::remove', ), 'up' => array ( 0 => 'class.ds-map.php', 1 => 'Ds\\Map', ), 'prev' => array ( 0 => 'ds-map.reduce.php', 1 => 'Ds\\Map::reduce', ), 'next' => array ( 0 => 'ds-map.reverse.php', 1 => 'Ds\\Map::reverse', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/ds/ds/map/remove.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PECL ds >= 1.0.0)
Ds\Map::remove — Удаляет и возвращает значение по ключу
Удаляет и возвращает значение по ключу, либо возвращает необязательное значение по умолчанию, если ключ не найден.
Замечание:
Поддерживаются значения типа object. Если объект реализует интерфейс Ds\Hashable, проверка производится путём вызова метода объекта
equals
. Если объект не реализует интерфейс Ds\Hashable, объекты должны ссылаться на один и тот же экземпляр класса.
Замечание:
Вы можете использовать синтаксис массива для доступа к значениям, т.е.
$map["key"]
.
Будьте осторожны при использовании синтаксиса массива. Скалярные ключи будут приведены
к целым движком PHP. К примеру, $map["1"]
будет пытаться обратиться
к int(1)
, тогда как $map->get("1")
обратится к
правильному элементу.
Смотрите раздел Массивы.
key
Ключ для удаления.
default
Необязательный параметр, устанавливающий возвращаемое значение по умолчанию, если ключ не найден.
Удалённое значение или default
, если он указан, а ключ
key
не найден.
Выбрасывает исключение OutOfRangeException, если ключ не найден и не задано значение по умолчанию.
Пример #1 Пример использования Ds\Map::remove()
<?php
$map = new \Ds\Map(["a" => 1, "b" => 2, "c" => 3]);
var_dump($map->remove("a")); // 1
var_dump($map->remove("e", 10)); // 10 (используется по умолчанию)
?>
Вывод приведённого примера будет похож на:
int(1) int(10)