php-doc-en/reference/array/functions/reset.xml
Horst Schirmeier 55db9ff77b reference to array function "end" added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@201468 c90b9560-bf6c-de11-be94-00142212c4b1
2005-11-28 01:33:59 +00:00

75 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
<refentry id="function.reset">
<refnamediv>
<refname>reset</refname>
<refpurpose>
Set the internal pointer of an array to its first element
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>reset</methodname>
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
</methodsynopsis>
<para>
<function>reset</function> rewinds <parameter>array</parameter>'s
internal pointer to the first element and returns the value of the first
array element, or &false; if the array is empty.
</para>
<para>
<example>
<title><function>reset</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array('step one', 'step two', 'step three', 'step four');
// by default, the pointer is on the first element
echo current($array) . "<br />\n"; // "step one"
// skip two steps
next($array);
next($array);
echo current($array) . "<br />\n"; // "step three"
// reset pointer, start again on step one
reset($array);
echo current($array) . "<br />\n"; // "step one"
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>current</function>,
<function>each</function>, <function>end</function>,
<function>next</function>, and <function>prev</function>.
</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:"../../../../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
-->