php-doc-en/reference/spl/recursivearrayiterator/haschildren.xml
2014-09-05 07:44:07 +00:00

108 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="recursivearrayiterator.haschildren" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>RecursiveArrayIterator::hasChildren</refname>
<refpurpose>Returns whether current entry is an array or an object.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RecursiveArrayIterator::hasChildren</methodname>
<void/>
</methodsynopsis>
<para>
Returns whether current entry is an <type>array</type> or an <type>object</type> for
which an iterator can be obtained via
<methodname>RecursiveArrayIterator::getChildren</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the current entry is an <type>array</type> or an <type>object</type>,
otherwise &false; is returned.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>RecursiveArrayIterator::hasChildren</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$fruits = array("a" => "lemon", "b" => "orange", array("a" => "apple", "p" => "pear"));
$iterator = new RecursiveArrayIterator($fruits);
while ($iterator->valid()) {
// Check if there are children
if ($iterator->hasChildren()) {
// print all children
foreach ($iterator->getChildren() as $key => $value) {
echo $key . ' : ' . $value . "\n";
}
} else {
echo "No children.\n";
}
$iterator->next();
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
No children.
No children.
a : apple
p : pear
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>RecursiveArrayIterator::getChildren</function></member>
</simplelist>
</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
-->