mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
69 lines
1.9 KiB
XML
69 lines
1.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="iterator.rewind" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Iterator::rewind</refname>
|
|
<refpurpose>Rewind the Iterator to the first element</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="Iterator">
|
|
<modifier>public</modifier> <type>void</type><methodname>Iterator::rewind</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
Rewinds back to the first element of the Iterator.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This is the <emphasis>first</emphasis> method called when starting a
|
|
&foreach; loop. It will <emphasis>not</emphasis> be
|
|
executed <emphasis>after</emphasis> &foreach; loops.
|
|
</para>
|
|
<simpara>
|
|
As &foreach; always calls <methodname>rewind</methodname> before starting
|
|
iteration, manually advancing the iterator position (for example via
|
|
<methodname>SplFileObject::seek</methodname>) will be reset.
|
|
</simpara>
|
|
<simpara>
|
|
To iterate without rewinding the iterator, wrap it in a
|
|
<classname>NoRewindIterator</classname>.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Any returned value is ignored.
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|