<!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>Construct an iterator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.tokyotyrantiterator.html">TokyoTyrantIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrantiterator.current.html">TokyoTyrantIterator::current</a></div>
<div class="up"><a href="class.tokyotyrantiterator.html">TokyoTyrantIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="tokyotyrantiterator.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrantIterator::__construct</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.2.0)</p><p class="refpurpose"><span class="refname">TokyoTyrantIterator::__construct</span> — <span class="dc-title">Construct an iterator</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrantiterator.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>TokyoTyrantIterator::__construct</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">$object</code></span>
)</div>
<p class="para rdfs-comment">
Construct a new TokyoTyrantIterator object. One connection can have multiple iterators but it is not quaranteed
that all items are traversed in that case. <em><code class="parameter">object</code></em> parameter can be either an of instance
TokyoTyrant or TokyoTyrantTable.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrantiterator.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrantiterator.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Throws an exception if iterator initialization fails.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrantiterator.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2242">
<p><strong>Example #1 <span class="methodname"><strong>TokyoTyrantIterator::__construct()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Connect to a table database */<br /></span><span style="color: #0000BB">$tt </span><span style="color: #007700">= new </span><span style="color: #0000BB">TokyoTyrantTable</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #0000BB">1979</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Passing null to put generates a new uid */<br /></span><span style="color: #0000BB">$index </span><span style="color: #007700">= </span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">put</span><span style="color: #007700">(</span><span style="color: #0000BB">null</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"column1" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"some data"</span><span style="color: #007700">, </span><span style="color: #DD0000">"column2" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"more data"</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">/* Construct an iterator */<br /></span><span style="color: #0000BB">$it </span><span style="color: #007700">= new </span><span style="color: #0000BB">TokyoTyrantIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$tt</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$it </span><span style="color: #007700">as </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</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:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["column1"]=>
string(9) "some data"
["column2"]=>
string(9) "more data"
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tokyotyrantiterator.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="tokyotyrantiterator.key.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantIterator::key()</a> - Returns the current key</span></li>
<li class="member"> <span class="methodname"><a href="tokyotyrantiterator.current.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantIterator::current()</a> - Get the current value</span></li>
<li class="member"> <span class="methodname"><a href="tokyotyrantiterator.next.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantIterator::next()</a> - Move to next key</span></li>
<li class="member"> <span class="methodname"><a href="tokyotyrantiterator.rewind.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantIterator::rewind()</a> - Rewinds the iterator</span></li>
<li class="member"> <span class="methodname"><a href="tokyotyrantiterator.key.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrantIterator::key()</a> - Returns the current key</span></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.tokyotyrantiterator.html">TokyoTyrantIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrantiterator.current.html">TokyoTyrantIterator::current</a></div>
<div class="up"><a href="class.tokyotyrantiterator.html">TokyoTyrantIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
