<!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>Updates all values by applying a callback function to each value</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-map.allocate.html">Ds\Map::allocate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-map.capacity.html">Ds\Map::capacity</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.apply" class="refentry">
<div class="refnamediv">
<h1 class="refname">Ds\Map::apply</h1>
<p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Map::apply</span> — <span class="dc-title">Updates all values by applying a callback function to each value</span></p>
</div>
<div class="refsect1 description" id="refsect1-ds-map.apply-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>Ds\Map::apply</strong></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<p class="para rdfs-comment">
Updates all values by applying a <code class="parameter">callback</code> function to
each value in the map.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ds-map.apply-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">callback</code></dt>
<dd>
<p class="para">
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
<span class="methodname"><span class="replaceable">callback</span></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
</p>
<p class="para">
A <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> to apply to each value in the map.
</p>
<p class="para">
The callback should return what the value should be replaced by.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ds-map.apply-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ds-map.apply-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5250">
<p><strong>Example #1 <span class="function"><strong>Ds\Map::apply()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$map </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">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">apply</span><span style="color: #007700">(function(</span><span style="color: #0000BB">$key</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">) { return </span><span style="color: #0000BB">$value </span><span style="color: #007700">* </span><span style="color: #0000BB">2</span><span style="color: #007700">; });<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</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] => 2
)
[1] => Ds\Pair Object
(
[key] => b
[value] => 4
)
[2] => Ds\Pair Object
(
[key] => c
[value] => 6
)
)
</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.allocate.html">Ds\Map::allocate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-map.capacity.html">Ds\Map::capacity</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>
