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.

Note:
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.

Note:
Pode-se também pode usar a sintaxe de array para acessar valores pela chave, por exemplo, $map["key"].

Caution

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

Example #1 Exemplo de 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 (padrão usado)
?>

O exemplo acima produzirá algo semelhante a:

int(1)
int(10)