Files
doc-fr/reference/spl/splqueue/setiteratormode.xml
George Peter Banyard bc20feba40 Apply commit 0081d5b1c1445fcab74716693501aba37fbfa3bd
Add missing visibility modifiers for SPL
2021-02-02 01:42:15 +00:00

95 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0081d5b1c1445fcab74716693501aba37fbfa3bd Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="splqueue.setiteratormode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplQueue::setIteratorMode</refname>
<refpurpose>Définit le mode de l'itérateur</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SplQueue::setIteratorMode</methodname>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Il n'y a qu'un paramètre de l'itérateur que vous pouvez modifier.
</para>
<itemizedlist>
<listitem>
<simpara>Le comportement de l'itérateur (l'un ou l'autre) :</simpara>
<itemizedlist>
<listitem><simpara><constant>SplDoublyLinkedList::IT_MODE_DELETE</constant> (Les éléments sont effacés par l'itérateur)</simpara></listitem>
<listitem><simpara><constant>SplDoublyLinkedList::IT_MODE_KEEP</constant> (Les éléments sont traversés par l'itérateur)</simpara></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Le mode par défaut est : <constant>SplDoublyLinkedList::IT_MODE_FIFO</constant> | <constant>SplDoublyLinkedList::IT_MODE_KEEP</constant>
</para>
<warning>
<para>
La direction de l'itérateur ne peut pas être modifiée pour les objets
<classname>SplQueues</classname> : c'est toujours
<constant>SplDoublyLinkedList::IT_MODE_FIFO</constant>.
</para>
</warning>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Émet une exception <classname>RuntimeException</classname> lors du
changement de direction de l'itération avec la constante
<constant>SplDoublyLinkedList::IT_MODE_LIFO</constant>.
</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
-->