<!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 a callable to determine which pairs to include</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-map.diff.html">Ds\Map::diff</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-map.first.html">Ds\Map::first</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.filter" class="refentry"> <div class="refnamediv"> <h1 class="refname">Ds\Map::filter</h1> <p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Map::filter</span> — <span class="dc-title"> Creates a new map using a <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> to determine which pairs to include </span></p> </div> <div class="refsect1 description" id="refsect1-ds-map.filter-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::filter</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"> Creates a new map using a <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> to determine which pairs to include. </p> </div> <div class="refsect1 parameters" id="refsect1-ds-map.filter-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">bool</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"> Optional <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> which returns <strong><code>TRUE</code></strong> if the pair should be included, <strong><code>FALSE</code></strong> otherwise. </p> <p class="para"> If a callback is not provided, only values which are <strong><code>TRUE</code></strong> (see <a href="language.types.boolean.html#language.types.boolean.casting" class="link">converting to boolean</a>) will be included. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-ds-map.filter-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A new map containing all the pairs for which either the <code class="parameter">callback</code> returned <strong><code>TRUE</code></strong>, or all values that convert to <strong><code>TRUE</code></strong> if a <code class="parameter">callback</code> was not provided. </p> </div> <div class="refsect1 examples" id="refsect1-ds-map.filter-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5256"> <p><strong>Example #1 <span class="function"><strong>Ds\Map::filter()</strong></span> example using callback function</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: #DD0000">"b"</span><span style="color: #007700">, </span><span style="color: #DD0000">"c"</span><span style="color: #007700">, </span><span style="color: #DD0000">"d"</span><span style="color: #007700">, </span><span style="color: #DD0000">"e"</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">filter</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">) {<br /> return </span><span style="color: #0000BB">$key </span><span style="color: #007700">% </span><span style="color: #0000BB">2 </span><span style="color: #007700">== </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br />}));<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> object(Ds\Map)#3 (3) { [0]=> object(Ds\Pair)#2 (2) { ["key"]=> int(0) ["value"]=> string(1) "a" } [1]=> object(Ds\Pair)#4 (2) { ["key"]=> int(2) ["value"]=> string(1) "c" } [2]=> object(Ds\Pair)#5 (2) { ["key"]=> int(4) ["value"]=> string(1) "e" } } </pre></div> </div> </div> <div class="example" id="example-5257"> <p><strong>Example #2 <span class="function"><strong>Ds\Map::filter()</strong></span> example without a callback function</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">0</span><span style="color: #007700">, </span><span style="color: #DD0000">"b" </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"c" </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">, </span><span style="color: #DD0000">"d" </span><span style="color: #007700">=> </span><span style="color: #0000BB">false</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">filter</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> object(Ds\Map)#2 (3) { [0]=> int(1) [1]=> string(1) "a" [2]=> bool(true) } </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.diff.html">Ds\Map::diff</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-map.first.html">Ds\Map::first</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>