sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Should be the last fix to SimpleXMLElement::children(). Grammar fixes, documented parameters, added additional example.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@295463 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Daniel Egeberg 2010-02-24 12:23:28 +00:00
parent ab93921763
commit 80cbff1fc0
1 changed files with 50 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
reference/simplexml/simplexmlelement/children.xml
View file

@ -13,12 +13,12 @@
<methodsynopsis>
<type>SimpleXMLElement</type><methodname>children</methodname>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This method finds the children of the element of which it is a member. The result
follows normal iteration rules.
This method finds the children of an element. The result follows normal
iteration rules.
</para>
&simplexml.iteration;
</refsect1>
@ -31,6 +31,7 @@
<term><parameter>ns</parameter></term>
<listitem>
<para>
An <acronym>XML</acronym> namespace.
</para>
</listitem>
</varlistentry>
@ -38,7 +39,10 @@
<term><parameter>is_prefix</parameter></term>
<listitem>
<para>
Default to &false;
If <parameter>ns_prefix</parameter> is &true;,
<parameter>ns</parameter> will be regarded as a namespace
<acronym>URL</acronym>. If &false;, <parameter>ns</parameter> will be
regarded as a prefix.
</para>
</listitem>
</varlistentry>
@ -50,7 +54,7 @@
&reftitle.returnvalues;
<para>
Returns a <classname>SimpleXMLElement</classname> element, whether the node
have children or not.
has children or not.
</para>
</refsect1>
@ -118,6 +122,46 @@ foreach ($xml->children() as $second_gen) {
<![CDATA[
The person begot a son who begot a daughter; The person
begot a daughter who begot a son; and that son begot a son
]]>
</screen>
</example>
<example>
<title>Using namespaces</title>
<programlisting role="php">
<![CDATA[
<?php
$xml = '<example xmlns:foo="my.foo.urn">
<foo:a>Apple</foo:a>
<foo:b>Banana</foo:b>
<c>Cherry</c>
</example>';
$sxe = new SimpleXMLElement($xml);
$kids = $sxe->children('foo');
var_dump(count($kids));
$kids = $sxe->children('foo', TRUE);
var_dump(count($kids));
$kids = $sxe->children('my.foo.urn');
var_dump(count($kids));
$kids = $sxe->children('my.foo.urn', TRUE);
var_dump(count($kids));
$kids = $sxe->children();
var_dump(count($kids));
?>
]]>
</programlisting>
<screen>
<![CDATA[
int(0)
int(2)
int(2)
int(0)
int(1)
]]>
</screen>
</example>
@ -129,7 +173,7 @@ begot a daughter who begot a son; and that son begot a son
<simpara>
<methodname>SimpleXMLElement::children</methodname> returns a node
object no matter if the current node have children or not. Use
object no matter if the current node has children or not. Use
<function>count</function> on the return value to see if there are any
children.
</simpara>