Files
doc-fr/reference/array/functions/reset.xml
Sergey Panteleev 13822e448b Sync various parts with English (#140)
Co-authored-by: George Peter Banyard <girgias@php.net>
2021-12-22 15:30:43 +00:00

143 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0a192fcd9cc43c0007de795063b4494974058992 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DavidA. -->
<refentry xml:id="function.reset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>reset</refname>
<refpurpose>Remet le pointeur interne de tableau au début</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> replace le pointeur de tableau
<parameter>array</parameter> au premier élément et retourne la valeur
du premier élément.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>array</parameter></term>
<listitem>
<para>
Le tableau d'entrée.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne la valeur du premier élément du tableau, ou &false; si le tableau
est vide.
</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>Exemple avec <function>reset</function></title>
<programlisting role="php">
<![CDATA[
<?php
$array = array('step one', 'step two', 'step three', 'step four');
// Par défaut, le pointeur est sur le premier élément
echo current($array) . "<br />\n"; // "step one"
// on saute deux éléments
next($array);
next($array);
echo current($array) . "<br />\n"; // "step three"
// on remet le pointeur au début
reset($array);
echo current($array) . "<br />\n"; // "step one"
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
La valeur retournée pour un tableau vide n'est pas distinguable de la
valeur retournée pour un tableau qui contient une valeur
<type>bool</type> &false; comme premier élément.
Pour proprement vérifier la valeur du premier élément d'un tableau,
qui peut contenir un élément &false;, il faut d'abord vérifier le
<function>count</function> du tableau, ou vérifier si la <function>key</function>
n'est pas &null;,
après avoir appelé <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>
<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
-->