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

Document SPL functions:

Browse source 
iterator_count()
  iterator_to_array()


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@278608 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Juliette 2009-04-12 01:45:35 +00:00
parent 9acefba1c2
commit 5e59fb9ef3
2 changed files with 72 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
reference/spl/functions/iterator-count.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.iterator-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>iterator_count</refname>
@ -12,9 +12,6 @@
<type>int</type><methodname>iterator_count</methodname>
<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Count the elements in an iterator.
</para>
@ -43,6 +40,29 @@
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>iterator_count</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$iterator = new ArrayIterator(array('recipe'=>'pancakes', 'egg', 'milk', 'flour'));
var_dump(iterator_count($iterator));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(4)
]]>
</screen>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/spl/functions/iterator-to-array.xml
View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.iterator-to-array" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>iterator_to_array</refname>
@ -13,11 +13,8 @@
<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_keys</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Count the elements in an iterator.
Copy the elements of an iterator into an array.
</para>
</refsect1>
@ -29,7 +26,7 @@
<term><parameter>iterator</parameter></term>
<listitem>
<para>
The iterator being counted.
The iterator being copied.
</para>
</listitem>
</varlistentry>
@ -37,7 +34,7 @@
<term><parameter>use_keys</parameter></term>
<listitem>
<para>
<!-- FIXME -->
Whether to use the iterator element keys as index.
</para>
</listitem>
</varlistentry>
@ -48,7 +45,50 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of elements in <parameter>iterator</parameter>.
An <type>array</type> containing the elements of the <parameter>iterator</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>iterator_to_array</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$iterator = new ArrayIterator(array('recipe'=>'pancakes', 'egg', 'milk', 'flour'));
var_dump(iterator_to_array($iterator, true));
var_dump(iterator_to_array($iterator, false));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(4) {
["recipe"]=>
string(8) "pancakes"
[0]=>
string(3) "egg"
[1]=>
string(4) "milk"
[2]=>
string(5) "flour"
}
array(4) {
[0]=>
string(8) "pancakes"
[1]=>
string(3) "egg"
[2]=>
string(4) "milk"
[3]=>
string(5) "flour"
}
]]>
</screen>
</example>
</para>
</refsect1>