doc-fr/reference/spl/cachingiterator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e22c3d32010c9bff72fd8db09314de30582720eb Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: yannick -->
<phpdoc:classref xml:id="class.cachingiterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>&class.theclass; CachingIterator</title>
 <titleabbrev>CachingIterator</titleabbrev>
 
 <partintro>
  
  <!-- {{{ CachingIterator intro -->
  <section xml:id="cachingiterator.intro">
   &reftitle.intro;
   <para>
    Cet objet supporte les itérations en cache sur un autre itérateur.
   </para>
  </section>
  <!-- }}} -->
  
  <section xml:id="cachingiterator.synopsis">
   &reftitle.classsynopsis;
   
<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>CachingIterator</classname>
    </ooclass>

    <classsynopsisinfo>
     <ooclass>
      <classname>CachingIterator</classname>
     </ooclass>

     <ooclass>
      <modifier>extends</modifier>
      <classname>IteratorIterator</classname>
     </ooclass>

     <oointerface>
      <interfacename>ArrayAccess</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Countable</interfacename>
     </oointerface>

     <oointerface>
      <interfacename>Stringable</interfacename>
     </oointerface>
    </classsynopsisinfo>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="cachingiterator.constants.call-tostring">CachingIterator::CALL_TOSTRING</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="cachingiterator.constants.catch-get-child">CachingIterator::CATCH_GET_CHILD</varname>
     <initializer>16</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="cachingiterator.constants.tostring-use-key">CachingIterator::TOSTRING_USE_KEY</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="cachingiterator.constants.tostring-use-current">CachingIterator::TOSTRING_USE_CURRENT</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="cachingiterator.constants.tostring-use-inner">CachingIterator::TOSTRING_USE_INNER</varname>
     <initializer>8</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="cachingiterator.constants.full-cache">CachingIterator::FULL_CACHE</varname>
     <initializer>256</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->
   
  </section>
  
  <!-- {{{ CachingIterator constants -->
  <section xml:id="cachingiterator.constants">
   &reftitle.constants;
   <variablelist>
    
    <varlistentry xml:id="cachingiterator.constants.call-tostring">
     <term><constant>CachingIterator::CALL_TOSTRING</constant></term>
     <listitem>
      <para>Convertit tous les éléments en chaines.</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="cachingiterator.constants.catch-get-child">
     <term><constant>CachingIterator::CATCH_GET_CHILD</constant></term>
     <listitem>
      <para>N'envoie aucune exception lors de la tentative d'accéder à un enfant.</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="cachingiterator.constants.tostring-use-key">
     <term><constant>CachingIterator::TOSTRING_USE_KEY</constant></term>
     <listitem>
      <para>Utilise <link linkend="cachingiterator.key">key</link> lors de la
      conversion en chaine.</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="cachingiterator.constants.tostring-use-current">
     <term><constant>CachingIterator::TOSTRING_USE_CURRENT</constant></term>
     <listitem>
      <para>Utilise <link linkend="cachingiterator.current">current</link> lors de la
      conversion en chaine.</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="cachingiterator.constants.tostring-use-inner">
     <term><constant>CachingIterator::TOSTRING_USE_INNER</constant></term>
     <listitem>
      <para>Utilise <link linkend="cachingiterator.getinneriterator">inner</link> lors de
      la conversion en chaine.</para>
     </listitem>
    </varlistentry>
    
    <varlistentry xml:id="cachingiterator.constants.full-cache">
     <term><constant>CachingIterator::FULL_CACHE</constant></term>
     <listitem>
      <para>
       Met en cache toutes les données lues.
      </para>
     </listitem>
    </varlistentry>
    
   </variablelist>
  </section>
  <!-- }}} -->
  
  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        La classe <classname>CachingIterator</classname> implémente désormais <interfacename>Stringable</interfacename>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>
  
 </partintro>
 
 &reference.spl.entities.cachingiterator;
 
</phpdoc:classref>
<!-- 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
-->