<!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>Seeks to a position</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.seekableiterator.html">SeekableIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spl.exceptions.html">Exceptions</a></div>
<div class="up"><a href="class.seekableiterator.html">SeekableIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="seekableiterator.seek" class="refentry">
<div class="refnamediv">
<h1 class="refname">SeekableIterator::seek</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">SeekableIterator::seek</span> — <span class="dc-title">Seeks to a position</span></p>
</div>
<div class="refsect1 description" id="refsect1-seekableiterator.seek-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>SeekableIterator::seek</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$position</code></span>
)</div>
<p class="para rdfs-comment">
Seeks to a given position in the iterator.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-seekableiterator.seek-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">position</code></em></span>
<dd>
<p class="para">
The position to seek to.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-seekableiterator.seek-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-seekableiterator.seek-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Implementations should throw an <a href="class.outofboundsexception.html" class="classname">OutOfBoundsException</a>
if the <em><code class="parameter">position</code></em> is not seekable.
</p>
</div>
<div class="refsect1 examples" id="refsect1-seekableiterator.seek-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3911">
<p><strong>Example #1 <span class="methodname"><strong>SeekableIterator::seek()</strong></span> example</strong></p>
<div class="example-contents"><p>
Seek to the item at position 3 in the iterator
(<a href="class.arrayiterator.html" class="classname">ArrayIterator</a> implements <a href="class.seekableiterator.html" class="classname">SeekableIterator</a>).
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"apple"</span><span style="color: #007700">, </span><span style="color: #DD0000">"banana"</span><span style="color: #007700">, </span><span style="color: #DD0000">"cherry"</span><span style="color: #007700">, </span><span style="color: #DD0000">"damson"</span><span style="color: #007700">, </span><span style="color: #DD0000">"elderberry"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$iterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">seek</span><span style="color: #007700">(</span><span style="color: #0000BB">3</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$iterator</span><span style="color: #007700">-></span><span style="color: #0000BB">current</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>
damson
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-seekableiterator.seek-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="class.seekableiterator.html" class="classname">SeekableIterator</a></li>
<li class="member"><a href="class.iterator.html" class="classname">Iterator</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.seekableiterator.html">SeekableIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="spl.exceptions.html">Exceptions</a></div>
<div class="up"><a href="class.seekableiterator.html">SeekableIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
