php-doc-en/reference/array/functions/next.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.next" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>next</refname>
  <refpurpose>Advance the internal array pointer of an array</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>next</methodname>
   <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>next</function> behaves like
   <function>current</function>, with one difference.  It advances
   the internal array pointer one place forward before returning the
   element value.  That means it returns the next array value and
   advances the internal array pointer by one.
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the array value in the next place that's pointed to by the
   internal array pointer, or &false; if there are no more elements.
  </para>
  &return.falseproblem;
  <note>
   <simpara>
    You won't be able to distinguish the end of an array from a
    <type>boolean</type> &false; element. To properly traverse an array
    which may contain &false; elements, see the <function>each</function>
    function.
   </simpara>
  </note>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Example use of <function>next</function> and friends</title>
    <programlisting role="php">
<![CDATA[
<?php
$transport = array('foot', 'bike', 'car', 'plane');
$mode = current($transport); // $mode = 'foot';
$mode = next($transport);    // $mode = 'bike';
$mode = next($transport);    // $mode = 'car';
$mode = prev($transport);    // $mode = 'bike';
$mode = end($transport);     // $mode = 'plane';
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>current</function></member>
    <member><function>end</function></member>
    <member><function>prev</function></member>
    <member><function>reset</function></member>
    <member><function>each</function></member>
   </simplelist>
  </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
-->