Ds\Map::remove
En esta página
Ds\Map::remove
Elimina y devuelve un valor por clave
Descripción#
public Ds\Map::remove(mixed $key, [mixed $default]): mixed
```php
Elimina y devuelve un valor por clave, o devuelve un valor por defecto opcional si la clave no ha podido ser encontrada.
> [!NOTE]
> Las claves de tipo `object` son soportadas. Si un objeto implementa `Ds\Hashable`, la igualdad será determinada por la función `equals` del objeto. Si un objeto no implementa `Ds\Hashable`, los objetos deben ser referencias a la misma instancia para ser considerados iguales.
> [!NOTE]
> Asimismo, se puede utilizar la sintaxis de array para acceder a los valores por clave, por ejemplo `$map["clé"]`.
> [!CAUTION]
> Atención al uso de la sintaxis de array. Las claves escalares serán forzadas a enteros por el motor. Por ejemplo, `$map["1"]` intentará acceder a `int(1)`, mientras que `$map->get("1")` buscará correctamente la clave de string.
>
> Ver [arrays](#language.types.array).
## Parámetros
`key`
La clave a eliminar.
`default`
El valor por defecto opcional, devuelto si la clave no ha podido ser encontrada.
## Valores devueltos
El valor que ha sido eliminado, o el `default` valor si ha sido proporcionado y la `key` no ha podido ser encontrada en el mapa.
## Errores/Excepciones
`OutOfBoundsException` si la clave no ha sido encontrada y ningún valor por defecto ha sido proporcionado.
## Ejemplos
Ejemplo de `Ds\Map::remove`
```php
Resultado del ejemplo anterior es similar a:
int(1)
int(10)