php-doc-en/language/oop5/iterations.xml
AllenJB 1fb0ef23d7
Fix #80942: Object iteration / Iterator: Replace duplicated examples with direct links
* Object iteration / Iterator: Replace duplicated examples with direct links to the appropriate sections and add cross-links.

Closes GH-517.
2021-04-20 11:28:39 +02:00

105 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<sect1 xml:id="language.oop5.iterations" xmlns="http://docbook.org/ns/docbook">
<title>Object Iteration</title>
<para>
PHP provides a way for objects to be defined so it is possible to iterate
through a list of items, with, for example a &foreach; statement. By default,
all <link linkend="language.oop5.visibility">visible</link> properties will be used
for the iteration.
</para>
<example>
<title>Simple Object Iteration</title>
<programlisting role="php">
<![CDATA[
<?php
class MyClass
{
public $var1 = 'value 1';
public $var2 = 'value 2';
public $var3 = 'value 3';
protected $protected = 'protected var';
private $private = 'private var';
function iterateVisible() {
echo "MyClass::iterateVisible:\n";
foreach ($this as $key => $value) {
print "$key => $value\n";
}
}
}
$class = new MyClass();
foreach($class as $key => $value) {
print "$key => $value\n";
}
echo "\n";
$class->iterateVisible();
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
var1 => value 1
var2 => value 2
var3 => value 3
MyClass::iterateVisible:
var1 => value 1
var2 => value 2
var3 => value 3
protected => protected var
private => private var
]]>
</screen>
</example>
<para>
As the output shows, the &foreach; iterated through all of the
<link linkend="language.oop5.visibility">visible</link> properties that could be
accessed.
</para>
<simplesect role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="language.generators">Generators</link></member>
<member><interfacename>Iterator</interfacename></member>
<member><interfacename>IteratorAggregate</interfacename> </member>
<member><link linkend="spl.iterators">SPL Iterators</link></member>
</simplelist>
</para>
</simplesect>
</sect1>
<!-- 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
-->