<!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 a subset of the map defined by a starting index and length</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-map.skip.html">Ds\Map::skip</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-map.sort.html">Ds\Map::sort</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.slice" class="refentry">
<div class="refnamediv">
<h1 class="refname">Ds\Map::slice</h1>
<p class="verinfo">(PECL ds >= 1.0.0)</p><p class="refpurpose"><span class="refname">Ds\Map::slice</span> — <span class="dc-title">
Returns a subset of the map defined by a starting index and length
</span></p>
</div>
<div class="refsect1 description" id="refsect1-ds-map.slice-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::slice</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
] )</div>
<p class="para rdfs-comment">
Returns a subset of the map defined by a starting <code class="parameter">index</code> and <code class="parameter">length</code>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ds-map.slice-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">index</code></dt>
<dd>
<p class="para">
The index at which the range starts.
</p>
<p class="para">
If positive, the range will start at that index in the map.
If negative, the range will start that far from the end.
</p>
</dd>
<dt>
<code class="parameter">length</code></dt>
<dd>
<p class="para">
If a length is given and is positive, the resulting
map will have up to that many pairs in it.
If a length is given and is negative, the range
will stop that many pairs from the end.
If the length results in an overflow, only
pairs up to the end of the map will be included.
If a length is not provided, the resulting map
will contain all pairs between the index and the
end of the map.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ds-map.slice-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A subset of the map defined by a starting index and length.
</p>
</div>
<div class="refsect1 examples" id="refsect1-ds-map.slice-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5283">
<p><strong>Example #1 <span class="function"><strong>Ds\Map::slice()</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">, </span><span style="color: #DD0000">"d" </span><span style="color: #007700">=> </span><span style="color: #0000BB">4</span><span style="color: #007700">, </span><span style="color: #DD0000">"e" </span><span style="color: #007700">=> </span><span style="color: #0000BB">5</span><span style="color: #007700">]);<br /><br /></span><span style="color: #FF8000">// Slice from 2 onwards<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">slice</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">)-></span><span style="color: #0000BB">toArray</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">// Slice from 1, for a length of 3<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">slice</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">)-></span><span style="color: #0000BB">toArray</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">// Slice from 1 onwards<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">slice</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">)-></span><span style="color: #0000BB">toArray</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">// Slice from 2 from the end onwards<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">slice</span><span style="color: #007700">(-</span><span style="color: #0000BB">2</span><span style="color: #007700">)-></span><span style="color: #0000BB">toArray</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">// Slice from 1 to 1 from the end<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$map</span><span style="color: #007700">-></span><span style="color: #0000BB">slice</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">)-></span><span style="color: #0000BB">toArray</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>
Array
(
[c] => 3
[d] => 4
[e] => 5
)
Array
(
[b] => 2
[c] => 3
[d] => 4
)
Array
(
[b] => 2
[c] => 3
[d] => 4
[e] => 5
)
Array
(
[d] => 4
[e] => 5
)
Array
(
[b] => 2
[c] => 3
[d] => 4
)
</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.skip.html">Ds\Map::skip</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-map.sort.html">Ds\Map::sort</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>
