<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Creates a new map using values from the current instance and another map</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-map.toarray.html">Ds\Map::toArray</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-map.values.html">Ds\Map::values</a></div>
<div class="up"><a href="class.ds-map.html">Map</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ds-map.union" class="refentry">
<div class="refnamediv">
<h1 class="refname">Ds\Map::union</h1>
<p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Map::union</span> — <span class="dc-title">Creates a new map using values from the current instance and another map</span></p>
</div>
<div class="refsect1 description" id="refsect1-ds-map.union-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type Ds\Map">Ds\Map</span></span> <span class="methodname"><strong>Ds\Map::union</strong></span>
( <span class="methodparam"><span class="type"><span class="type Ds\Map">Ds\Map</span></span> <code class="parameter">$map</code></span>
)</div>
<p class="para rdfs-comment">
Creates a new map that contains the pairs of the current instance as well as the
pairs of another <code class="parameter">map</code>.
</p>
<p class="para">
<code class="code">A ∪ B = {x: x ∈ A ∨ x ∈ B}</code>
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Values of the current instance will be overwritten by those provided where keys are equal.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-ds-map.union-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">map</code></dt>
<dd>
<p class="para">
The other map, to combine with the current instance.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ds-map.union-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A new map containing all the pairs of the current instance as well as another <code class="parameter">map</code>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-ds-map.union-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="https://en.wikipedia.org/wiki/Union_(set_theory)" class="link external">» Union</a> on Wikipedia</li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-ds-map.union-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5291">
<p><strong>Example #1 <span class="function"><strong>Ds\Map::union()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$a </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Map</span><span style="color: #007700">([</span><span style="color: #DD0000">"a" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"b" </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #DD0000">"c" </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$b </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Ds</span><span style="color: #007700">\</span><span style="color: #0000BB">Map</span><span style="color: #007700">([</span><span style="color: #DD0000">"b" </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #DD0000">"c" </span><span style="color: #007700">=> </span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #DD0000">"d" </span><span style="color: #007700">=> </span><span style="color: #0000BB">5</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$a</span><span style="color: #007700">-></span><span style="color: #0000BB">union</span><span style="color: #007700">(</span><span style="color: #0000BB">$b</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Ds\Map Object
(
[0] => Ds\Pair Object
(
[key] => a
[value] => 1
)
[1] => Ds\Pair Object
(
[key] => b
[value] => 3
)
[2] => Ds\Pair Object
(
[key] => c
[value] => 4
)
[3] => Ds\Pair Object
(
[key] => d
[value] => 5
)
)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-map.toarray.html">Ds\Map::toArray</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-map.values.html">Ds\Map::values</a></div>
<div class="up"><a href="class.ds-map.html">Map</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
