<!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>Retrieve an external iterator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.iteratoraggregate.html">IteratorAggregate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.arrayaccess.html">ArrayAccess</a></div>
<div class="up"><a href="class.iteratoraggregate.html">IteratorAggregate</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="iteratoraggregate.getiterator" class="refentry">
<div class="refnamediv">
<h1 class="refname">IteratorAggregate::getIterator</h1>
<p class="verinfo">(PHP 5 >= 5.0.0)</p><p class="refpurpose"><span class="refname">IteratorAggregate::getIterator</span> — <span class="dc-title">Retrieve an external iterator</span></p>
</div>
<div class="refsect1 description" id="refsect1-iteratoraggregate.getiterator-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type"><a href="class.traversable.html" class="type Traversable">Traversable</a></span> <span class="methodname"><strong>IteratorAggregate::getIterator</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Returns an external iterator.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-iteratoraggregate.getiterator-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-iteratoraggregate.getiterator-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An instance of an object implementing <a href="class.iterator.html" class="classname">Iterator</a> or
<a href="class.traversable.html" class="classname">Traversable</a>
</p>
</div>
<div class="refsect1 errors" id="refsect1-iteratoraggregate.getiterator-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws an <a href="class.exception.html" class="classname">Exception</a> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.iteratoraggregate.html">IteratorAggregate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.arrayaccess.html">ArrayAccess</a></div>
<div class="up"><a href="class.iteratoraggregate.html">IteratorAggregate</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
