reset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0a192fcd9cc43c0007de795063b4494974058992 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: cd943f94a013b74df8765ab8e1a620a916a64a85 Reviewer: samesch -->
<!-- CREDITS: tom, simp -->
<refentry xml:id="function.reset" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>reset</refname>
  <refpurpose>Setzt den internen Zeiger eines Arrays auf sein erstes Element</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>reset</methodname>
   <methodparam><type class="union"><type>array</type><type>object</type></type><parameter role="reference">array</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>reset</function> setzt den internen Zeiger von
   <parameter>array</parameter> auf das erste Element zurück und gibt den Wert
   des ersten Arrayelements zurück.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Das Eingabe-Array.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt das erste Element des Arrays zurück oder &false; wenn das Array leer
   ist.
  </para>
  &return.falseproblem;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &standard.changelog.calling-on-objects;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>reset</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

$array = array('step one', 'step two', 'step three', 'step four');

// normalerweise steht der interne Zeiger auf dem ersten Element
echo current($array) . "<br />\n"; // "step one"

// Zwei Elemente überspringen
next($array);
next($array);
echo current($array) . "<br />\n"; // "step three"

// Zeiger zurücksetzen auf das erste Element und wieder bei step one beginnen
reset($array);
echo current($array) . "<br />\n"; // "step one"

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    Der Rückgabewert für ein leeres Array ist nicht zu unterscheiden vom
    Rückgabewert eines Arrays, das ein <type>bool</type> &false; als erstes
    Element hat. Um den Wert des ersten Elements eines Arrays ordnungsgemäß
    zu prüfen, das &false;-Elemente enthalten kann, ist zunächst der
    <function>count</function> des Arrays zu prüfen oder sicherzustellen,
    dass <function>key</function> nicht &null; ist, nachdem
    <function>reset</function> aufgerufen wurde.
   </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>
    <member><function>array_key_first</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
-->