php8.5
Home/ Manual/ ds / map/ Ds\Map::merge

Ds\Map::merge

PHP function Edit on GitHub ✎

(PECL ds >= 1.0.0)

Returns the result of adding all given associations

Description

Ds\Map::merge(mixed $values): Ds\Map

Returns the result of associating all keys of a given traversable object or Array with their corresponding values, combined with the current instance.

Note

Values of the current instance will be overwritten by those provided where keys are equal.

Parameters

values

A traversable object or an Array.

Return Values

The result of associating all keys of a given traversable object or Array with their corresponding values, combined with the current instance.

Note

The current instance won't be affected.

Examples

Ds\Map::merge() example

php
<?php
$map = new \Ds\Map(["a" => 1, "b" => 2, "c" => 3]);

print_r($map->merge(["a" => 10, "e" => 50]));
?>

The above example will output something similar to:

output
Ds\Map Object
(
    [0] => Ds\Pair Object
        (
            [key] => a
            [value] => 10
        )

    [1] => Ds\Pair Object
        (
            [key] => b
            [value] => 2
        )

    [2] => Ds\Pair Object
        (
            [key] => c
            [value] => 3
        )

    [3] => Ds\Pair Object
        (
            [key] => e
            [value] => 50
        )

)

Source: reference/ds/ds/map/merge.xml · from the official PHP manual (php/doc-en)