Ds\Map::remove
(PECL ds >= 1.0.0)
Ds\Map::remove — Removes and returns a value by key.
Описание
Removes and returns a value by key, or return an optional default value if the key could not be found.
Замечание:
Keys of type object are supported. If an object implements Ds\Hashable, equality will be determined by the object's
equalsfunction. If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal.
Замечание:
You can also use array syntax to access values by key, eg.
$map["key"].
Be careful when using array syntax. Scalar keys will be coerced to
integers by the engine. For example, $map["1"] will attempt
to access int(1), while $map->get("1") will
correctly look up the string key.
See Arrays.
Список параметров
-
key -
The key to remove.
-
default -
The optional default value, returned if the key could not be found.
Возвращаемые значения
The value that was removed, or the default
value if provided and the key could not be found in the map.
Ошибки
OutOfBoundsException if the key could not be found and a default value was not provided.
Примеры
Пример #1 Ds\Map::remove() example
<?php
$map = new \Ds\Map(["a" => 1, "b" => 2, "c" => 3]);
var_dump($map->remove("a")); // 1
var_dump($map->remove("e", 10)); // 10 (default used)
?>
Результатом выполнения данного примера будет что-то подобное:
int(1) int(10)
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения, относящиеся к переменным и типам
- Data Structures
- Ds\Map::allocate
- Ds\Map::apply
- Ds\Map::capacity
- Ds\Map::clear
- Ds\Map::__construct
- Ds\Map::copy
- Ds\Map::count
- Ds\Map::diff
- Ds\Map::filter
- Ds\Map::first
- Ds\Map::get
- Ds\Map::hasKey
- Ds\Map::hasValue
- Ds\Map::intersect
- Ds\Map::isEmpty
- Ds\Map::jsonSerialize
- Ds\Map::keys
- Ds\Map::ksort
- Ds\Map::ksorted
- Ds\Map::last
- Ds\Map::map
- Ds\Map::merge
- Ds\Map::pairs
- Ds\Map::put
- Ds\Map::putAll
- Ds\Map::reduce
- Ds\Map::remove
- Ds\Map::reverse
- Ds\Map::reversed
- Ds\Map::skip
- Ds\Map::slice
- Ds\Map::sort
- Ds\Map::sorted
- Ds\Map::sum
- Ds\Map::toArray
- Ds\Map::union
- Ds\Map::values
- Ds\Map::xor
Коментарии
Note the syntax
<?php
unset($map[$key]);
?>
is also valid and ran 2x faster on my machine