File: traversable.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (108 lines) | stat: -rw-r--r-- 2,920 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.traversable" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The <interfacename>Traversable</interfacename> interface</title>
 <titleabbrev>Traversable</titleabbrev>

 <partintro>

<!-- {{{ Traversable intro -->
  <section xml:id="traversable.intro">
   &reftitle.intro;
   <para>
    Interface to detect if a class is traversable using &foreach;.
   </para>
   <para>
    Abstract base interface that cannot be implemented alone. Instead, it must
    be implemented by either <interfacename>IteratorAggregate</interfacename> or
    <interfacename>Iterator</interfacename>.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="traversable.synopsis">
   &reftitle.interfacesynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="interface">
    <oointerface>
     <interfacename>Traversable</interfacename>
    </oointerface>
   </classsynopsis>
<!-- }}} -->

   <para>
    This interface has no methods, its only purpose is to be the base
    interface for all traversable classes.
   </para>

  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.4.0</entry>
       <entry>
        The <interfacename>Traversable</interfacename> interface can now be implemented
        by abstract classes. Extending classes must implement
        <interfacename>Iterator</interfacename> or
        <interfacename>IteratorAggregate</interfacename>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>

  <section role="notes">
   &reftitle.notes;
   <note>
    <para>
     Internal (built-in) classes that implement this interface can be used in
     a &foreach; construct and do not need to implement
     <interfacename>IteratorAggregate</interfacename> or
     <interfacename>Iterator</interfacename>.
    </para>
   </note>
   <note>
    <para>
     Prior to PHP 7.4.0, this internal engine interface couldn't be implemented
     in PHP scripts. Either <interfacename>IteratorAggregate</interfacename>
     or <interfacename>Iterator</interfacename> must be used instead.
    </para>
   </note>
  </section>

 </partintro>

</reference>
<!-- 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
-->