reset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 0a192fcd9cc43c0007de795063b4494974058992 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.reset" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>reset</refname>
  <refpurpose>Устанавливает внутренний указатель массива на первый элемент</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> сдвигает внутренний указатель массива
   <parameter>array</parameter> на первый элемент и возвращает
   значение первого элемента массива.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Входной массив.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает значение первого элемента массива или &false;, если
   массив пуст.
  </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></title>
    <programlisting role="php">
<![CDATA[
<?php

$array = array('первый шаг', 'второй шаг', 'третий шаг', 'четвёртый шаг');

// По умолчанию указатель указывает на первый элемент
echo current($array) . "<br />\n"; // "первый шаг"

// Пропускаем два шага
next($array);
next($array);
echo current($array) . "<br />\n"; // "третий шаг"

// Сбрасываем указатель, снова начинаем с первого шага
reset($array);
echo current($array) . "<br />\n"; // "первый шаг"

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <simpara>
    Возвращаемое значение для пустого массива
    неотличимо от значения в случае массива, значение первого элемента которого
    равно логическому (<type>bool</type>) значению &false;.
    Чтобы правильно проверить значение
    первого элемента массива, который содержит значение &false;,
    сначала функцией <function>count</function> проверяют
    количество элементов в массиве
    или после вызова функции <function>reset</function>
    проверяют, что ключ, возвращаемый функцией
    <function>key</function>, не равен значению &null;.
   </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
-->