<!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>Returns the value for a given key</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-map.first.html">Ds\Map::first</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-map.haskey.html">Ds\Map::hasKey</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.get" class="refentry"> <div class="refnamediv"> <h1 class="refname">Ds\Map::get</h1> <p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Map::get</span> — <span class="dc-title">Returns the value for a given key</span></p> </div> <div class="refsect1 description" id="refsect1-ds-map.get-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Ds\Map::get</strong></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">$default</code></span> ] )</div> <p class="para rdfs-comment"> Returns the value for a given key, or an optional default value if the key could not be found. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> Keys of type <span class="type"><a href="language.types.object.html" class="type object">object</a></span> are supported. If an object implements <strong class="classname">Ds\Hashable</strong>, equality will be determined by the object's <code class="code">equals</code> function. If an object does not implement <strong class="classname">Ds\Hashable</strong>, objects must be references to the same instance to be considered equal. </p> </p></blockquote> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> You can also use array syntax to access values by key, eg. <code class="code">$map["key"]</code>. </p> </p></blockquote> <div class="caution"><strong class="caution">Caution</strong> <p class="para"> Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For example, <code class="code">$map["1"]</code> will attempt to access <code class="code">int(1)</code>, while <code class="code">$map->get("1")</code> will correctly look up the string key. </p> <p class="para"> See <a href="language.types.array.html" class="link">Arrays</a>. </p> </div> </div> <div class="refsect1 parameters" id="refsect1-ds-map.get-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">key</code></dt> <dd> <p class="para"> The key to look up. </p> </dd> <dt> <code class="parameter">default</code></dt> <dd> <p class="para"> The optional default value, returned if the key could not be found. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-ds-map.get-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The value mapped to the given <code class="parameter">key</code>, or the <code class="parameter">default</code> value if provided and the key could not be found in the map. </p> </div> <div class="refsect1 errors" id="refsect1-ds-map.get-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> <a href="class.outofboundsexception.html" class="classname">OutOfBoundsException</a> if the key could not be found and a default value was not provided. </p> </div> <div class="refsect1 examples" id="refsect1-ds-map.get-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-5259"> <p><strong>Example #1 <span class="function"><strong>Ds\Map::get()</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 /><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">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"a"</span><span style="color: #007700">)); </span><span style="color: #FF8000">// 1<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">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"d"</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">)); </span><span style="color: #FF8000">// 10 (default used)<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> int(1) int(10) </pre></div> </div> </div> <div class="example" id="example-5260"> <p><strong>Example #2 <span class="function"><strong>Ds\Map::get()</strong></span> example using array syntax</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 /><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: #DD0000">"a"</span><span style="color: #007700">])); </span><span style="color: #FF8000">// 1<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> int(1) </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.first.html">Ds\Map::first</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-map.haskey.html">Ds\Map::hasKey</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>