1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 15:52:15 +01:00

Generate ext/spl methodsynopses based on stubs (#624)

This commit is contained in:
Máté Kocsis
2021-08-11 23:44:41 +02:00
committed by GitHub
parent 554179d438
commit 60809ebcf7
185 changed files with 662 additions and 727 deletions

View File

@@ -39,7 +39,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Always returns &true;.
</para>
</refsect1>
<refsect1 role="examples">

View File

@@ -36,7 +36,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Always returns &true;.
</para>
</refsect1>
<refsect1 role="examples">

View File

@@ -40,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Always returns &true;.
</para>
</refsect1>
<refsect1 role="examples">

View File

@@ -43,7 +43,9 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.appenditerator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.appenditerator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.appenditerator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="appenditerator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AppendIterator::__construct</refname>
@@ -9,10 +8,9 @@
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="oop">
<modifier>public</modifier>
<methodname>AppendIterator::__construct</methodname>
<void />
<constructorsynopsis>
<modifier>public</modifier> <methodname>AppendIterator::__construct</methodname>
<void/>
</constructorsynopsis>
<para>
Constructs an AppendIterator.
@@ -130,7 +128,6 @@ while ($appendIterator->valid()) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="appenditerator.getiteratorindex" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>AppendIterator::getIteratorIndex</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>AppendIterator::getIteratorIndex</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>int</type><type>null</type></type><methodname>AppendIterator::getIteratorIndex</methodname>
<void/>
</methodsynopsis>
<para>
Gets the index of the current inner iterator.
@@ -26,8 +25,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <type>int</type>, which is the zero-based index
of the current inner iterator.
Returns the zero-based, integer index of the current inner iterator if it exists, or &null; otherwise.
</para>
</refsect1>
@@ -79,7 +77,6 @@ foreach ($iterator as $key => $current) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -79,6 +79,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.asort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::asort</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::asort</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::asort</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SORT_REGULAR</constant></initializer></methodparam>
</methodsynopsis>
<para>
Sorts an array by values.
@@ -29,7 +28,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
Always returns &true;.
</para>
</refsect1>
@@ -45,7 +44,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::__construct</refname>
@@ -9,11 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>ArrayIterator::__construct</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>array</parameter><initializer>array()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs an <classname>ArrayIterator</classname> <type>object</type>.
</para>
@@ -72,7 +71,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.ksort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::ksort</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::ksort</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::ksort</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SORT_REGULAR</constant></initializer></methodparam>
</methodsynopsis>
<para>
Sorts an array by the keys.
@@ -29,7 +28,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
Always returns &true;.
</para>
</refsect1>
@@ -45,7 +44,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.natcasesort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::natcasesort</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::natcasesort</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::natcasesort</methodname>
<void/>
</methodsynopsis>
<para>
Sort the entries by values using a case insensitive "natural order" algorithm.
@@ -46,7 +45,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.natsort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::natsort</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::natsort</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::natsort</methodname>
<void/>
</methodsynopsis>
<para>
Sort the entries by values using "natural order" algorithm.
@@ -46,7 +45,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::offsetExists</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::offsetExists</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Checks if the offset exists.
@@ -26,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The offset being checked.
@@ -54,7 +53,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::offsetGet</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>ArrayIterator::offsetGet</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Gets the value from the provided offset.
@@ -26,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The offset to get the value from.
@@ -40,7 +39,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The value at offset <parameter>index</parameter>.
The value at offset <parameter>key</parameter>.
</para>
</refsect1>
@@ -55,7 +54,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.offsetset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::offsetSet</refname>
@@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::offsetSet</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Sets a value for a given offset.
@@ -27,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index to set for.
@@ -35,7 +34,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newval</parameter></term>
<term><parameter>value</parameter></term>
<listitem>
<para>
The new value to store at the index.
@@ -64,7 +63,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::offsetUnset</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::offsetUnset</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Unsets a value for an offset.
@@ -33,7 +32,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The offset to unset.
@@ -62,7 +61,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::seek</methodname>
<methodparam><type>int</type><parameter>position</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
@@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>position</parameter></term>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The position to seek to.
@@ -40,7 +40,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::setFlags</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::setFlags</methodname>
<methodparam><type>string</type><parameter>flags</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Set the flags that change the behavior of the ArrayIterator.
@@ -84,7 +83,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.uasort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::uasort</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::uasort</methodname>
<methodparam><type>callable</type><parameter>cmp_function</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::uasort</methodname>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
This method sorts the elements such that indices maintain their correlation
@@ -26,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>cmp_function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
&return.callbacksort;
@@ -57,7 +56,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.uksort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::uksort</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::uksort</methodname>
<methodparam><type>callable</type><parameter>cmp_function</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>ArrayIterator::uksort</methodname>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
This method sorts the elements by keys using a user-supplied comparison
@@ -25,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>cmp_function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
&return.callbacksort;
@@ -56,7 +55,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayiterator.unserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayIterator::unserialize</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayIterator::unserialize</methodname>
<methodparam><type>string</type><parameter>serialized</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Unserialize.
@@ -26,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>serialized</parameter></term>
<term><parameter>data</parameter></term>
<listitem>
<para>
The serialized ArrayIterator object to be unserialized.
@@ -54,7 +53,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::asort</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::asort</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SORT_REGULAR</constant></initializer></methodparam>
</methodsynopsis>
<para>
@@ -82,7 +82,6 @@ a = orange
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -103,4 +102,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -10,9 +10,9 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>ArrayObject::__construct</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>input</parameter><initializer>array()</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter><initializer>[]</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iterator_class</parameter><initializer>"ArrayIterator"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iteratorClass</parameter><initializer>ArrayIterator::class</initializer></methodparam>
</constructorsynopsis>
<para>
This constructs a new array <type>object</type>.
@@ -24,10 +24,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<term><parameter>array</parameter></term>
<listitem>
<para>
The <parameter>input</parameter> parameter accepts an
The <parameter>array</parameter> parameter accepts an
<type>array</type> or an <type>Object</type>.
</para>
</listitem>
@@ -42,7 +42,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>iterator_class</parameter></term>
<term><parameter>iteratorClass</parameter></term>
<listitem>
<para>
Specify the class that will be used for iteration of the <classname>ArrayObject</classname> object.
@@ -68,7 +68,7 @@
<itemizedlist>
<listitem>
<simpara>
<parameter>input</parameter> is not an array or object
<parameter>array</parameter> is not an array or object
</simpara>
</listitem>
<listitem>
@@ -78,7 +78,7 @@
</listitem>
<listitem>
<simpara>
<parameter>iterator_class</parameter> is not an object that implements
<parameter>iteratorClass</parameter> is not an object that implements
<classname>Iterator</classname>
</simpara>
</listitem>
@@ -131,7 +131,6 @@ object(ArrayObject)#1 (3) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>ArrayObject::exchangeArray</methodname>
<methodparam><type>mixed</type><parameter>input</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>object</type></type><parameter>array</parameter></methodparam>
</methodsynopsis>
<para>
Exchange the current <type>array</type> with another <type>array</type> or <type>object</type>.
@@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<term><parameter>array</parameter></term>
<listitem>
<para>
The new <type>array</type> or <type>object</type> to exchange with the current array.
@@ -84,7 +84,6 @@ ArrayObject Object
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -105,4 +104,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>ArrayIterator</type><methodname>ArrayObject::getIterator</methodname>
<modifier>public</modifier> <type>Iterator</type><methodname>ArrayObject::getIterator</methodname>
<void/>
</methodsynopsis>
<para>
@@ -65,7 +65,6 @@ while($iterator->valid()) {
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::ksort</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::ksort</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SORT_REGULAR</constant></initializer></methodparam>
</methodsynopsis>
<para>
@@ -76,7 +76,6 @@ d = lemon
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::natcasesort</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::natcasesort</methodname>
<void/>
</methodsynopsis>
<para>
@@ -84,8 +84,7 @@ ArrayObject Object
]]>
</screen>
<para>
For more information see: Martin Pool's <link
xlink:href="&url.strnatcmp;">Natural Order String Comparison</link>
For more information see: Martin Pool's <link xlink:href="&url.strnatcmp;">Natural Order String Comparison</link>
page.
</para>
</example>
@@ -106,7 +105,6 @@ ArrayObject Object
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -127,4 +125,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::natsort</methodname>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::natsort</methodname>
<void/>
</methodsynopsis>
<para>
@@ -79,8 +79,7 @@ ArrayObject Object
]]>
</screen>
<para>
For more information see: Martin Pool's <link
xlink:href="&url.strnatcmp;">Natural Order String Comparison</link>
For more information see: Martin Pool's <link xlink:href="&url.strnatcmp;">Natural Order String Comparison</link>
page.
</para>
</example>
@@ -101,7 +100,6 @@ ArrayObject Object
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::offsetExists</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
</refsect1>
@@ -18,7 +18,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index being checked.
@@ -64,7 +64,6 @@ bool(false)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>ArrayObject::offsetGet</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
</refsect1>
@@ -18,7 +18,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index with the value.
@@ -72,7 +72,6 @@ bool(false)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::offsetSet</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
@@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index being set.
@@ -31,10 +31,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newval</parameter></term>
<term><parameter>value</parameter></term>
<listitem>
<para>
The new value for the <parameter>index</parameter>.
The new value for the <parameter>key</parameter>.
</para>
</listitem>
</varlistentry>

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::offsetUnset</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
</methodsynopsis>
<para>
Unsets the value at the specified index.
@@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index being unset.
@@ -67,7 +67,6 @@ object(ArrayObject)#1 (1) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::setIteratorClass</methodname>
<methodparam><type>string</type><parameter>iterator_class</parameter></methodparam>
<methodparam><type>string</type><parameter>iteratorClass</parameter></methodparam>
</methodsynopsis>
<para>
Sets the classname of the array iterator that is used by
@@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>iterator_class</parameter></term>
<term><parameter>iteratorClass</parameter></term>
<listitem>
<para>
The classname of the array iterator to use when iterating over this object.
@@ -82,7 +82,6 @@ MyArrayIterator Object
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::uasort</methodname>
<methodparam><type>callable</type><parameter>cmp_function</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::uasort</methodname>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
This function sorts the entries such that keys maintain their
@@ -27,10 +27,10 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>cmp_function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Function <parameter>cmp_function</parameter> should accept two
Function <parameter>callback</parameter> should accept two
parameters which will be filled by pairs of entries.
The comparison function must return an integer less than, equal
to, or greater than zero if the first argument is considered to
@@ -122,7 +122,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::uksort</methodname>
<methodparam><type>callable</type><parameter>cmp_function</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>ArrayObject::uksort</methodname>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
This function sorts the keys of the entries using a user-supplied
@@ -22,13 +22,13 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>cmp_function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The callback comparison function.
</para>
<para>
Function <parameter>cmp_function</parameter> should accept two
Function <parameter>callback</parameter> should accept two
parameters which will be filled by pairs of entry keys.
The comparison function must return an integer less than, equal
to, or greater than zero if the first argument is considered to
@@ -99,7 +99,6 @@ John: 1
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -120,4 +119,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayobject.unserialize" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayObject::unserialize</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::unserialize</methodname>
<methodparam><type>string</type><parameter>serialized</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Unserializes a serialized <classname>ArrayObject</classname>.
@@ -26,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>serialized</parameter></term>
<term><parameter>data</parameter></term>
<listitem>
<para>
The serialized <classname>ArrayObject</classname>.
@@ -56,7 +55,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -85,8 +85,11 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<!--
<!--
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-->

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::__construct</refname>
@@ -9,11 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CachingIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>self::CALL_TOSTRING</initializer></methodparam>
</methodsynopsis>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>CachingIterator::CALL_TOSTRING</initializer></methodparam>
</constructorsynopsis>
&warn.undocumented.func;
@@ -45,7 +44,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.hasnext" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::hasNext</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>CachingIterator::hasNext</methodname>
<void />
<void/>
</methodsynopsis>
&warn.undocumented.func;
@@ -31,7 +30,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::offsetExists</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetExists</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>CachingIterator::offsetExists</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
@@ -23,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index being checked.
@@ -43,7 +42,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::offsetGet</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetGet</methodname>
<methodparam><type>string</type><parameter>index</parameter></methodparam>
<modifier>public</modifier> <type>mixed</type><methodname>CachingIterator::offsetGet</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
@@ -23,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
Description...
@@ -43,7 +42,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.offsetset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::offsetSet</refname>
@@ -11,8 +10,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetSet</methodname>
<methodparam><type>mixed</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
@@ -24,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index of the element to be set.
@@ -32,10 +31,10 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newval</parameter></term>
<term><parameter>value</parameter></term>
<listitem>
<para>
The new value for the <parameter>index</parameter>.
The new value for the <parameter>key</parameter>.
</para>
</listitem>
</varlistentry>
@@ -52,7 +51,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::offsetUnset</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CachingIterator::offsetUnset</methodname>
<methodparam><type>string</type><parameter>index</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
@@ -23,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>index</parameter></term>
<term><parameter>key</parameter></term>
<listitem>
<para>
The index of the element to be unset.
@@ -43,7 +42,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::__toString</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CachingIterator::__toString</methodname>
<void />
<modifier>public</modifier> <type>string</type><methodname>CachingIterator::__toString</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
@@ -34,7 +33,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="cachingiterator.valid" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CachingIterator::valid</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>CachingIterator::valid</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>CachingIterator::valid</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
@@ -34,7 +33,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -42,7 +42,9 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.callbackfilteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.callbackfilteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.callbackfilteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="callbackfilteriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>CallbackFilterIterator::__construct</refname>
@@ -9,9 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="oop">
<modifier>public</modifier>
<methodname>CallbackFilterIterator::__construct</methodname>
<constructorsynopsis>
<modifier>public</modifier> <methodname>CallbackFilterIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</constructorsynopsis>
@@ -66,7 +64,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="countable.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Countable::count</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>abstract</modifier> <modifier>public</modifier> <type>int</type><methodname>Countable::count</methodname>
<void />
<modifier>public</modifier> <type>int</type><methodname>Countable::count</methodname>
<void/>
</methodsynopsis>
<para>
This method is executed when using the <function>count</function> function on an
@@ -79,7 +78,6 @@ I have been count()ed 10 times
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -100,4 +98,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -10,7 +10,7 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>DirectoryIterator::__construct</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
</constructorsynopsis>
<para>
@@ -23,7 +23,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The path of the directory to traverse.
@@ -38,11 +38,11 @@
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>path</parameter> cannot be opened.
if the <parameter>directory</parameter> cannot be opened.
</para>
<para>
Throws a <classname>RuntimeException</classname>
if the <parameter>path</parameter> is an empty string.
if the <parameter>directory</parameter> is an empty string.
</para>
</refsect1>
@@ -81,7 +81,6 @@ foreach ($dir as $fileinfo) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,13 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>string</type>
<methodname>DirectoryIterator::getBasename</methodname>
<methodparam choice="opt">
<type>string</type>
<parameter>suffix</parameter>
</methodparam>
<modifier>public</modifier> <type>string</type><methodname>DirectoryIterator::getBasename</methodname>
<methodparam choice="opt"><type>string</type><parameter>suffix</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Get the base name of the current <classname>DirectoryIterator</classname> item.

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type> <methodname>DirectoryIterator::key</methodname>
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>DirectoryIterator::key</methodname>
<void/>
</methodsynopsis>
@@ -25,7 +25,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The key for the current <classname>DirectoryIterator</classname> item.
The key for the current <classname>DirectoryIterator</classname> item on success, or &false; on failure.
</para>
</refsect1>
@@ -73,7 +73,6 @@ foreach ($dir as $fileinfo) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,10 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type>
<methodname>DirectoryIterator::seek</methodname>
<methodparam><type>int</type><parameter>position</parameter></methodparam>
<modifier>public</modifier> <type>void</type><methodname>DirectoryIterator::seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
@@ -24,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>position</parameter></term>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The zero-based numeric position to seek to.
@@ -80,7 +78,6 @@ if ($iterator->valid()) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="emptyiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EmptyIterator::current</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>EmptyIterator::current</methodname>
<void />
<void/>
</methodsynopsis>
<para>
This function must not be called. It throws an exception upon access.
@@ -41,7 +40,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="emptyiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EmptyIterator::key</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>scalar</type><methodname>EmptyIterator::key</methodname>
<void />
<modifier>public</modifier> <type>mixed</type><methodname>EmptyIterator::key</methodname>
<void/>
</methodsynopsis>
<para>
This function must not be called. It throws an exception upon access.
@@ -41,7 +40,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -111,8 +111,11 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.directoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="filesystemiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>FilesystemIterator::__construct</refname>
@@ -9,13 +8,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>FilesystemIterator::__construct</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS</initializer></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a new filesystem iterator from the <parameter>path</parameter>.
Constructs a new filesystem iterator from the <parameter>directory</parameter>.
</para>
</refsect1>
@@ -25,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The path of the filesystem item to be iterated over.
@@ -63,7 +62,7 @@
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>path</parameter> cannot be found.
if the <parameter>directory</parameter> cannot be found.
</para>
</refsect1>
@@ -104,7 +103,6 @@ example.php
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="filesystemiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>FilesystemIterator::current</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>FilesystemIterator::current</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>string</type><type>SplFileInfo</type><type>FilesystemIterator</type></type><methodname>FilesystemIterator::current</methodname>
<void/>
</methodsynopsis>
<para>
Get file information of the current element.
@@ -74,7 +73,6 @@ foreach ($iterator as $fileinfo) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="filesystemiterator.setflags" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>FilesystemIterator::setFlags</refname>
@@ -11,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>FilesystemIterator::setFlags</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Sets handling flags.
@@ -99,7 +98,6 @@ example.php
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -53,6 +53,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filteriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>

View File

@@ -9,9 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>abstract</modifier>
<type>bool</type><methodname>FilterIterator::accept</methodname>
<modifier>public</modifier> <type>bool</type><methodname>FilterIterator::accept</methodname>
<void/>
</methodsynopsis>
<para>
@@ -69,7 +67,6 @@ more than 10 characters
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="filteriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>FilterIterator::__construct</refname>
@@ -9,11 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<methodname>FilterIterator::__construct</methodname>
<constructorsynopsis>
<modifier>public</modifier> <methodname>FilterIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a new <classname>FilterIterator</classname>, which consists of
a passed in <parameter>iterator</parameter> with filters applied to it.
@@ -56,7 +54,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -10,13 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>class_implements</methodname>
<methodparam><type>mixed</type><parameter>class</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>class_implements</methodname>
<methodparam><type class="union"><type>object</type><type>string</type></type><parameter>object_or_class</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>autoload</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
This function returns an array with the names of the interfaces that the
given <parameter>class</parameter> and its parents implement.
given <parameter>object_or_class</parameter> and its parents implement.
</para>
</refsect1>
@@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<term><parameter>object_or_class</parameter></term>
<listitem>
<para>
An object (class instance) or a string (class or interface name).
@@ -48,7 +48,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array on success, or &false; on error.
An array on success, or &false; when the given class doesn't exist.
</para>
</refsect1>
@@ -108,7 +108,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -10,13 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>class_parents</methodname>
<methodparam><type>mixed</type><parameter>class</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>class_parents</methodname>
<methodparam><type class="union"><type>object</type><type>string</type></type><parameter>object_or_class</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>autoload</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
This function returns an array with the name of the parent classes of
the given <parameter>class</parameter>.
the given <parameter>object_or_class</parameter>.
</para>
</refsect1>
@@ -25,7 +25,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<term><parameter>object_or_class</parameter></term>
<listitem>
<para>
An object (class instance) or a string (class name).
@@ -47,7 +47,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array on success, or &false; on error.
An array on success, or &false; when the given class doesn't exist.
</para>
</refsect1>
@@ -106,7 +106,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -10,13 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>class_uses</methodname>
<methodparam><type>mixed</type><parameter>class</parameter></methodparam>
<type class="union"><type>array</type><type>false</type></type><methodname>class_uses</methodname>
<methodparam><type class="union"><type>object</type><type>string</type></type><parameter>object_or_class</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>autoload</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
This function returns an array with the names of the traits that the
given <parameter>class</parameter> uses. This does however not include
given <parameter>object_or_class</parameter> uses. This does however not include
any traits used by a parent class.
</para>
</refsect1>
@@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>class</parameter></term>
<term><parameter>object_or_class</parameter></term>
<listitem>
<para>
An object (class instance) or a string (class name).
@@ -49,7 +49,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An array on success, or &false; on error.
An array on success, or &false; when the given class doesn't exist.
</para>
</refsect1>
@@ -110,7 +110,6 @@ Array
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.iterator-apply" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>iterator_apply</refname>
@@ -12,8 +11,8 @@
<methodsynopsis>
<type>int</type><methodname>iterator_apply</methodname>
<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>args</parameter><initializer>&null;</initializer></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>args</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Calls a function for every element in an iterator.
@@ -33,7 +32,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The callback function to call on every element.
@@ -55,7 +54,7 @@
<para>
An <type>array</type> of arguments; each element of
<parameter>args</parameter> is passed to the callback
<parameter>function</parameter> as separate argument.
<parameter>callback</parameter> as separate argument.
</para>
</listitem>
</varlistentry>
@@ -148,7 +147,6 @@ CHERRIES
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -11,7 +11,7 @@
<methodsynopsis>
<type>array</type><methodname>iterator_to_array</methodname>
<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_keys</parameter><initializer>&true;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>preserve_keys</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Copy the elements of an iterator into an array.
@@ -31,7 +31,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>use_keys</parameter></term>
<term><parameter>preserve_keys</parameter></term>
<listitem>
<para>
Whether to use the iterator element keys as index.
@@ -110,7 +110,6 @@ array(4) {
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>spl_autoload_call</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
</methodsynopsis>
<para>
This function can be used to manually search for a class or interface
@@ -22,7 +22,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>class_name</parameter></term>
<term><parameter>class</parameter></term>
<listitem>
<para>
The class name being searched.
@@ -41,7 +41,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>spl_autoload_extensions</methodname>
<methodparam choice="opt"><type>string</type><parameter>file_extensions</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>file_extensions</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
This function can modify and check the file extensions that the built in
@@ -31,7 +31,7 @@
<term><parameter>file_extensions</parameter></term>
<listitem>
<para>
When calling without an argument, it simply returns the current list
If &null;, it simply returns the current list
of extensions each separated by comma. To modify the list of file
extensions, simply invoke the functions with the new list of file
extensions to use in a single string with each extensions separated
@@ -51,6 +51,30 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>file_extensions</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
@@ -66,7 +90,6 @@ spl_autoload_extensions(".php,.inc");
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>spl_autoload_register</methodname>
<methodparam choice="opt"><type>callable</type><parameter>autoload_function</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>throw</parameter><initializer>&true;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>prepend</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
@@ -38,11 +38,11 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>autoload_function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The autoload function being registered.
If no parameter is provided, then the default implementation of
If &null;, then the default implementation of
<function>spl_autoload</function> will be registered.
</para>
<methodsynopsis>
@@ -57,7 +57,7 @@
<para>
This parameter specifies whether
<function>spl_autoload_register</function> should throw
exceptions when the <parameter>autoload_function</parameter>
exceptions when the <parameter>callback</parameter>
cannot be registered.
</para>
</listitem>
@@ -82,6 +82,30 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>callback</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -152,7 +176,6 @@ Fatal error: Class 'Foobar\InexistentClass' not found in ...
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>spl_autoload_unregister</methodname>
<methodparam><type>mixed</type><parameter>autoload_function</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
Removes a function from the autoload queue. If the queue
@@ -27,7 +27,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>autoload_function</parameter></term>
<term><parameter>callback</parameter></term>
<listitem>
<para>
The autoload function being unregistered.
@@ -46,7 +46,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,8 +9,8 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>spl_autoload</methodname>
<methodparam><type>string</type><parameter>class_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>file_extensions</parameter><initializer>spl_autoload_extensions()</initializer></methodparam>
<methodparam><type>string</type><parameter>class</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>file_extensions</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
This function is intended to be used as a default implementation for
@@ -26,7 +26,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>class_name</parameter></term>
<term><parameter>class</parameter></term>
<listitem>
<para>
The lowercased name of the class (and namespace) being instantiated.
@@ -39,7 +39,7 @@
<para>
By default it checks all include paths to
contain filenames built up by the lowercase class name appended by the
filename extensions .inc and .php.
filename extensions .inc and .php.
</para>
</listitem>
</varlistentry>
@@ -54,6 +54,30 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>file_extensions</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
@@ -63,7 +87,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>spl_object_hash</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
<methodparam><type>object</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
This function returns a unique identifier for the object. This id can be
@@ -71,7 +71,6 @@ $storage[$id] = $object;
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>spl_object_id</methodname>
<methodparam><type>object</type><parameter>obj</parameter></methodparam>
<methodparam><type>object</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
This function returns a unique identifier for the object. The object id is
@@ -71,7 +71,6 @@ $storage[$id] = $object;
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -52,6 +52,9 @@
</xi:include>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.globiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.globiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="globiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>GlobIterator::__construct</refname>
@@ -9,11 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>GlobIterator::__construct</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO</initializer></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a new directory iterator from a glob expression.
</para>
@@ -92,7 +91,6 @@ Matched 2 item(s)
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -45,8 +45,11 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.infiniteiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.infiniteiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="infiniteiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>InfiniteIterator::__construct</refname>
@@ -9,10 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>InfiniteIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs an <classname>InfiniteIterator</classname>
from an <classname>Iterator</classname>.
@@ -96,7 +95,6 @@ cat
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -42,6 +42,9 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="iteratoriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IteratorIterator::__construct</refname>
@@ -9,10 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>IteratorIterator::__construct</methodname>
<methodparam><type>Traversable</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>class</parameter><initializer>&null;</initializer></methodparam>
</constructorsynopsis>
<para>
Creates an iterator from anything that is traversable.
</para>
@@ -50,7 +50,6 @@
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="iteratoriterator.getinneriterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IteratorIterator::getInnerIterator</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Traversable</type><methodname>IteratorIterator::getInnerIterator</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>Iterator</type><type>null</type></type><methodname>IteratorIterator::getInnerIterator</methodname>
<void/>
</methodsynopsis>
<para>
Get the inner iterator.
@@ -26,7 +25,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inner iterator as passed to <methodname>IteratorIterator::__construct</methodname>.
The inner iterator as passed to <methodname>IteratorIterator::__construct</methodname>, or &null; when there is no inner iterator.
</para>
</refsect1>
@@ -41,7 +40,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -51,6 +51,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.limititerator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.limititerator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="limititerator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>LimitIterator::__construct</refname>
@@ -9,12 +8,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>LimitIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a new <classname>LimitIterator</classname> from an
<parameter>iterator</parameter> with a given starting
@@ -108,7 +107,6 @@ d
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -9,10 +9,10 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>LimitIterator::seek</methodname>
<methodparam><type>int</type><parameter>position</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
Moves the iterator to the offset specified by <parameter>position</parameter>.
Moves the iterator to the offset specified by <parameter>offset</parameter>.
</para>
</refsect1>
@@ -21,7 +21,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>position</parameter></term>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The position to seek to.
@@ -61,7 +61,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="multipleiterator.attachiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MultipleIterator::attachIterator</refname>
@@ -12,7 +11,7 @@
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>MultipleIterator::attachIterator</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>infos</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>int</type><type>null</type></type><parameter>info</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Attaches iterator information.
@@ -35,7 +34,7 @@
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>infos</parameter></term>
<term><parameter>info</parameter></term>
<listitem>
<para>
The associative information for the Iterator, which must be an
@@ -58,7 +57,7 @@
&reftitle.errors;
<para>
An <classname>IllegalValueException</classname> if the <parameter>iterator</parameter> parameter
is invalid, or if <parameter>infos</parameter> is already associated
is invalid, or if <parameter>info</parameter> is already associated
information.
</para>
</refsect1>
@@ -73,7 +72,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="multipleiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MultipleIterator::__construct</refname>
@@ -10,13 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier>
<methodname>MultipleIterator::__construct</methodname>
<methodparam choice="opt">
<type>int</type>
<parameter>flags</parameter>
<initializer>MultipleIterator::MIT_NEED_ALL|MultipleIterator::MIT_KEYS_NUMERIC</initializer>
</methodparam>
<modifier>public</modifier> <methodname>MultipleIterator::__construct</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC</initializer></methodparam>
</constructorsynopsis>
<para>
Construct a new MultipleIterator.
@@ -178,7 +172,6 @@ Array
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="multipleiterator.current" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MultipleIterator::current</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>MultipleIterator::current</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>MultipleIterator::current</methodname>
<void/>
</methodsynopsis>
<para>
Get the registered iterator instances current() result.
@@ -54,7 +53,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="multipleiterator.key" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MultipleIterator::key</refname>
@@ -10,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>MultipleIterator::key</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>MultipleIterator::key</methodname>
<void/>
</methodsynopsis>
<para>
Get the registered iterator instances key() result.
@@ -56,7 +55,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -46,6 +46,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.norewinditerator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.norewinditerator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="norewinditerator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>NoRewindIterator::__construct</refname>
@@ -9,10 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>NoRewindIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a NoRewindIterator.
</para>
@@ -96,7 +95,6 @@ Fruit B:
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Iterator</type><methodname>OuterIterator::getInnerIterator</methodname>
<modifier>public</modifier> <type class="union"><type>Iterator</type><type>null</type></type><methodname>OuterIterator::getInnerIterator</methodname>
<void/>
</methodsynopsis>
<para>
@@ -24,12 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inner iterator for the current entry.
Returns the inner iterator for the current entry if it exists, or &null; otherwise.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -56,6 +56,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parentiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynospsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parentiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.outeriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="parentiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ParentIterator::__construct</refname>
@@ -9,10 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>ParentIterator::__construct</methodname>
<methodparam><type>RecursiveIterator</type><parameter>iterator</parameter></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a <classname>ParentIterator</classname> on an iterator.
</para>
@@ -46,7 +45,6 @@
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>RecursiveArrayIterator</type><methodname>RecursiveArrayIterator::getChildren</methodname>
<modifier>public</modifier> <type class="union"><type>RecursiveArrayIterator</type><type>null</type></type><methodname>RecursiveArrayIterator::getChildren</methodname>
<void/>
</methodsynopsis>
<para>
@@ -24,7 +24,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An iterator for the current entry, if it is an <type>array</type> or <type>object</type>.
An iterator for the current entry, if it is an <type>array</type> or <type>object</type>; or &null; on failure.
</para>
</refsect1>
@@ -87,7 +87,6 @@ p : pear
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -67,6 +67,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivecachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivecachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherits</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="recursivecachingiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RecursiveCachingIterator::__construct</refname>
@@ -9,11 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>RecursiveCachingIterator::__construct</methodname>
<methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>self::CALL_TOSTRING</initializer></methodparam>
</methodsynopsis>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>RecursiveCachingIterator::CALL_TOSTRING</initializer></methodparam>
</constructorsynopsis>
<para>
Constructs a new <classname>RecursiveCachingIterator</classname>,
which consists of a passed in <parameter>iterator</parameter>.
@@ -66,7 +65,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>RecursiveCachingIterator</type><methodname>RecursiveCachingIterator::getChildren</methodname>
<modifier>public</modifier> <type class="union"><type>RecursiveCachingIterator</type><type>null</type></type><methodname>RecursiveCachingIterator::getChildren</methodname>
<void/>
</methodsynopsis>
@@ -24,12 +24,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inner iterator's children, as a RecursiveCachingIterator.
The inner iterator's children, as a RecursiveCachingIterator; or &null; if there is no children.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="recursivecallbackfilteriterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RecursiveCallbackFilterIterator::__construct</refname>
@@ -9,9 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis role="oop">
<modifier>public</modifier>
<methodname>RecursiveCallbackFilterIterator::__construct</methodname>
<constructorsynopsis>
<modifier>public</modifier> <methodname>RecursiveCallbackFilterIterator::__construct</methodname>
<methodparam><type>RecursiveIterator</type><parameter>iterator</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</constructorsynopsis>
@@ -68,7 +66,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -60,6 +60,9 @@
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivedirectoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])">
<xi:fallback />
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.recursivedirectoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">Inherits</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

View File

@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="recursivedirectoryiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RecursiveDirectoryIterator::__construct</refname>
@@ -9,14 +8,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>RecursiveDirectoryIterator::__construct</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO</initializer></methodparam>
</methodsynopsis>
</constructorsynopsis>
<para>
Constructs a <methodname>RecursiveDirectoryIterator</methodname>
for the provided <parameter>path</parameter>.
for the provided <parameter>directory</parameter>.
</para>
</refsect1>
@@ -25,7 +24,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<term><parameter>directory</parameter></term>
<listitem>
<para>
The path of the directory to be iterated over.
@@ -58,7 +57,7 @@
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>path</parameter> cannot be found or is not a directory.
if the <parameter>directory</parameter> cannot be found or is not a directory.
</para>
</refsect1>
@@ -123,7 +122,6 @@ Key: /tmp/veggies/carrot.xml
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -8,7 +8,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>RecursiveDirectoryIterator::getChildren</methodname>
<modifier>public</modifier> <type>RecursiveDirectoryIterator</type><methodname>RecursiveDirectoryIterator::getChildren</methodname>
<void/>
</methodsynopsis>
@@ -31,7 +31,6 @@
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

Some files were not shown because too many files have changed in this diff Show More