<!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>Constructs an AppendIterator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="appenditerator.append.html">AppendIterator::append</a></div>
<div class="next" style="text-align: right; float: right;"><a href="appenditerator.current.html">AppendIterator::current</a></div>
<div class="up"><a href="class.appenditerator.html">AppendIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="appenditerator.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">AppendIterator::__construct</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">AppendIterator::__construct</span> — <span class="dc-title">Constructs an AppendIterator</span></p>
</div>
<div class="refsect1 description" id="refsect1-appenditerator.construct-description">
<h3 class="title">Description</h3>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span>
<span class="methodname"><strong>AppendIterator::__construct()</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Constructs an AppendIterator.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-appenditerator.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-appenditerator.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-appenditerator.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="appenditerator.examples.foreach">
<p><strong>Example #1 Iterating AppendIterator with foreach</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$pizzas </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'Margarita'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Siciliana'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Hawaii'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$toppings </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'Cheese'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Anchovies'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Olives'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Pineapple'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Ham'</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$appendIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">AppendIterator</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #0000BB">$pizzas</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #0000BB">$toppings</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$appendIterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$item</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$key </span><span style="color: #007700">. </span><span style="color: #DD0000">' => ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$item </span><span style="color: #007700">. </span><span style="color: #0000BB">PHP_EOL</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>
0 => Margarita
1 => Siciliana
2 => Hawaii
0 => Cheese
1 => Anchovies
2 => Olives
3 => Pineapple
4 => Ham
</pre></div>
</div>
</div>
<div class="example" id="appenditerator.examples.api">
<p><strong>Example #2 Iterating AppendIterator with the AppendIterator API</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$pizzas </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'Margarita'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Siciliana'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Hawaii'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$toppings </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'Cheese'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Anchovies'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Olives'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Pineapple'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Ham'</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$appendIterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">AppendIterator</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #0000BB">$pizzas</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">append</span><span style="color: #007700">(</span><span style="color: #0000BB">$toppings</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">valid</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'%s => %s => %s%s'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">getIteratorIndex</span><span style="color: #007700">(),<br /> </span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">key</span><span style="color: #007700">(),<br /> </span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">current</span><span style="color: #007700">(),<br /> </span><span style="color: #0000BB">PHP_EOL<br /> </span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$appendIterator</span><span style="color: #007700">-></span><span style="color: #0000BB">next</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>
0 => 0 => Margarita
0 => 1 => Siciliana
0 => 2 => Hawaii
1 => 0 => Cheese
1 => 1 => Anchovies
1 => 2 => Olives
1 => 3 => Pineapple
1 => 4 => Ham
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-appenditerator.construct-notes">
<h3 class="title">Notes</h3>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
When using <span class="function"><a href="function.iterator-to-array.html" class="function">iterator_to_array()</a></span> to copy the values of the AppendIterator
into an array, you have to set the optional <em><code class="parameter">use_key</code></em> argument to
<strong><code>FALSE</code></strong>. When <em><code class="parameter">use_key</code></em> is not <strong><code>FALSE</code></strong> any keys reoccuring in inner
iterators will get overwritten in the returned array. There is no way to preserve the original keys.
</p>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-appenditerator.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="appenditerator.append.html" class="methodname" rel="rdfs-seeAlso">AppendIterator::append()</a> - Appends an iterator</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="appenditerator.append.html">AppendIterator::append</a></div>
<div class="next" style="text-align: right; float: right;"><a href="appenditerator.current.html">AppendIterator::current</a></div>
<div class="up"><a href="class.appenditerator.html">AppendIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
