mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
109 lines
2.9 KiB
XML
109 lines
2.9 KiB
XML
<?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
|
|
-->
|