mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
eccca2de38
"strictly different from <type>null</type>" implies a type check, what is not necessarily appropriate here. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343965 c90b9560-bf6c-de11-be94-00142212c4b1
118 lines
3.1 KiB
XML
118 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.reset" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>reset</refname>
|
|
<refpurpose>Set the internal pointer of an array to its first element</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input array.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the value of the first array element, or &false; if the array is
|
|
empty.
|
|
</para>
|
|
&return.falseproblem;
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<simpara>
|
|
The return value for an empty array is indistinguishable from
|
|
the return value in case of an array which has a <type>boolean</type> &false;
|
|
first element. To properly check the value of the first element of an array
|
|
which may contain &false; elements, first check the <function>count</function>
|
|
of the array, or check that <function>key</function> is not
|
|
&null;, after calling <function>reset</function>.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>current</function></member>
|
|
<member><function>each</function></member>
|
|
<member><function>end</function></member>
|
|
<member><function>next</function></member>
|
|
<member><function>prev</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:"~/.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
|
|
-->
|