Ds\Map::remove

(PECL ds >= 1.0.0)

Ds\Map::remove — Remove e retorna um valor pela chave

Descrição

public Ds\Map::remove(mixed $key, mixed $default = ?): mixed

Remove e retorna um valor pela chave, ou retorna um valor padrão opcional se a chave não puder ser encontrada.

Nota:
Chaves do tipo object são suportadas. Se um objeto implementar Ds\Hashable, a igualdade será determinada pela função equals do objeto. Se um objeto não implementar Ds\Hashable, objetos devem ser referências à mesma instância para serem considerados iguais.

Nota:
Você também pode usar a sintaxe de array para acessar valores pela chave, por exemplo, $map["key"].

Cuidado

Tenha cuidado ao usar a sintaxe de array. Chaves escalares serão convertidas para inteiros pelo motor. Por exemplo, $map["1"] tentará acessar int(1), enquanto $map->get("1") irá corretamente procurar a chave de string.

Veja Arrays.

Parâmetros

key: A chave a ser removida.
default: O valor padrão opcional, retornado se a chave não puder ser encontrada.

Valor Retornado

O valor que foi removido, ou o valor default se fornecido e a key não puder ser encontrada no mapa.

Erros/Exceções

OutOfBoundsException se a chave não puder ser encontrada e um valor padrão não foi fornecido.

Exemplos

Exemplo #1 Ds\Map::remove() exemplo

<?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)
?>

O exemplo acima produzirá algo semelhante a:

int(1)
int(10)

add a note

User Contributed Notes 1 note

down

carlo dot revelli at berkeley dot edu ¶

5 years ago


Note the syntax 

<?php

unset($map[$key]);

?>

is also valid and ran 2x faster on my machine

add a note