La función Ds\Map::remove() es una función incorporada en PHP que se utiliza para eliminar y devolver un valor por clave.
Sintaxis:
mixed Ds\Map::remove( $key, $default )
Parámetros: esta función acepta dos parámetros, como se mencionó anteriormente y se describe a continuación:
- $key: contiene el valor de la clave que debe eliminarse.
- $predeterminado: es un parámetro opcional y regresa si no se encuentra la clave.
Valor devuelto: esta función devuelve el valor que se eliminó.
Excepción: esta función genera una excepción OutOfRangeException si la clave no existe y no se proporciona el valor de $default.
Los siguientes programas ilustran la función Ds\Map::remove() en PHP:
Ejemplo 1:
<?php
// Declare new Map
$map = new \Ds\Map([
1 => "geeks",
2 => "for",
3 => "geeks",
4 => "DataStructures"
]);
echo("Map Elements\n");
// Display the map elements
print_r($map);
echo("\nRemoved element of the map: \n");
// Use remove() function to remove
// value at index 3 and return it
var_dump($map->remove(3));
?>
Producción:
Map Elements
Ds\Map Object
(
[0] => Ds\Pair Object
(
[key] => 1
[value] => geeks
)
[1] => Ds\Pair Object
(
[key] => 2
[value] => for
)
[2] => Ds\Pair Object
(
[key] => 3
[value] => geeks
)
[3] => Ds\Pair Object
(
[key] => 4
[value] => DataStructures
)
)
Removed element of the map:
string(5) "geeks"
Ejemplo:
<?php
// Declare new Map
$map = new \Ds\Map([
"a" => "geeks",
"b" => "for",
"c" => "geeks",
"d" => "DataStructures"
]);
echo("Map Elements\n");
// Display the map elements
print_r($map);
echo("\nRemoved element of the map: \n");
// Use remove() function to remove
// value at index 3 and return it
var_dump($map->remove("c"));
?>
Producción:
Map Elements
Ds\Map Object
(
[0] => Ds\Pair Object
(
[key] => a
[value] => geeks
)
[1] => Ds\Pair Object
(
[key] => b
[value] => for
)
[2] => Ds\Pair Object
(
[key] => c
[value] => geeks
)
[3] => Ds\Pair Object
(
[key] => d
[value] => DataStructures
)
)
Removed element of the map:
string(5) "geeks"
Referencia: https://www.php.net/manual/en/ds-map.remove.php