From 177245cff66664bd5a4a7d88f0b5a241bfc5c186 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Mon, 29 Jun 2009 23:38:46 +0000 Subject: [PATCH] Added skeletons (with brief docs) for appendIterator git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283080 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/spl/appenditerator.xml | 88 +++++++++++++++++++ reference/spl/appenditerator/append.xml | 77 ++++++++++++++++ reference/spl/appenditerator/construct.xml | 66 ++++++++++++++ reference/spl/appenditerator/current.xml | 66 ++++++++++++++ .../spl/appenditerator/getarrayiterator.xml | 66 ++++++++++++++ .../spl/appenditerator/getinneriterator.xml | 66 ++++++++++++++ .../spl/appenditerator/getiteratorindex.xml | 66 ++++++++++++++ reference/spl/appenditerator/key.xml | 66 ++++++++++++++ reference/spl/appenditerator/next.xml | 67 ++++++++++++++ reference/spl/appenditerator/rewind.xml | 66 ++++++++++++++ reference/spl/appenditerator/valid.xml | 66 ++++++++++++++ reference/spl/iterators.xml | 5 +- 12 files changed, 762 insertions(+), 3 deletions(-) create mode 100644 reference/spl/appenditerator.xml create mode 100644 reference/spl/appenditerator/append.xml create mode 100644 reference/spl/appenditerator/construct.xml create mode 100644 reference/spl/appenditerator/current.xml create mode 100644 reference/spl/appenditerator/getarrayiterator.xml create mode 100644 reference/spl/appenditerator/getinneriterator.xml create mode 100644 reference/spl/appenditerator/getiteratorindex.xml create mode 100644 reference/spl/appenditerator/key.xml create mode 100644 reference/spl/appenditerator/next.xml create mode 100644 reference/spl/appenditerator/rewind.xml create mode 100644 reference/spl/appenditerator/valid.xml diff --git a/reference/spl/appenditerator.xml b/reference/spl/appenditerator.xml new file mode 100644 index 0000000000..032a0d126e --- /dev/null +++ b/reference/spl/appenditerator.xml @@ -0,0 +1,88 @@ + + + + + + The AppendIterator class + AppendIterator + + + + +
+ &reftitle.intro; + + Iterate over multiple collections. + +
+ + +
+ &reftitle.classsynopsis; + + + + AppendIterator + + + + + AppendIterator + + + + extends + IteratorIterator + + + + OuterIterator + + + + Traversable + + + + Iterator + + + + + Methods + + + Inherited methods + + + + + +
+ +
+ + &reference.spl.entities.appenditerator; + +
+ + diff --git a/reference/spl/appenditerator/append.xml b/reference/spl/appenditerator/append.xml new file mode 100644 index 0000000000..c7fd20e53b --- /dev/null +++ b/reference/spl/appenditerator/append.xml @@ -0,0 +1,77 @@ + + + + + + AppendIterator::append + Appends an iterator + + + + &reftitle.description; + + public voidAppendIterator::append + Iteratoriterator + + + Appends an iterator. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + + iterator + + + The iterator to append. + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + AppendIterator::__construct + + + + + + + diff --git a/reference/spl/appenditerator/construct.xml b/reference/spl/appenditerator/construct.xml new file mode 100644 index 0000000000..5550994d7d --- /dev/null +++ b/reference/spl/appenditerator/construct.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::__construct + Constructs an AppendIterator + + + + &reftitle.description; + + AppendIterator::__construct + + + + Constructs an AppendIterator. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + AppendIterator::append + + + + + + + diff --git a/reference/spl/appenditerator/current.xml b/reference/spl/appenditerator/current.xml new file mode 100644 index 0000000000..3f8361c791 --- /dev/null +++ b/reference/spl/appenditerator/current.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::current + Gets the current value + + + + &reftitle.description; + + public voidAppendIterator::current + + + + Gets the current value. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current value if it is valid or &null; otherwise. + + + + + &reftitle.seealso; + + + AppendIterator::next + + + + + + + diff --git a/reference/spl/appenditerator/getarrayiterator.xml b/reference/spl/appenditerator/getarrayiterator.xml new file mode 100644 index 0000000000..03692b45f5 --- /dev/null +++ b/reference/spl/appenditerator/getarrayiterator.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::getArrayIterator + The getArrayIterator method + + + + &reftitle.description; + + public voidAppendIterator::getArrayIterator + + + + The getArrayIterator method + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + AppendIterator::getInnerIterator + + + + + + + diff --git a/reference/spl/appenditerator/getinneriterator.xml b/reference/spl/appenditerator/getinneriterator.xml new file mode 100644 index 0000000000..6db309e7d1 --- /dev/null +++ b/reference/spl/appenditerator/getinneriterator.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::getInnerIterator + Gets an inner iterator + + + + &reftitle.description; + + public voidAppendIterator::getInnerIterator + + + + Get an inner iterator + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current inner Iterator. + + + + + &reftitle.seealso; + + + AppendIterator::getArrayIterator + + + + + + + diff --git a/reference/spl/appenditerator/getiteratorindex.xml b/reference/spl/appenditerator/getiteratorindex.xml new file mode 100644 index 0000000000..284938e117 --- /dev/null +++ b/reference/spl/appenditerator/getiteratorindex.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::getIteratorIndex + Gets an index of iterators + + + + &reftitle.description; + + public voidAppendIterator::getIteratorIndex + + + + Get an index of iterators. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The index of iterators. + + + + + &reftitle.seealso; + + + AppendIterator::getInnerIterator + + + + + + + diff --git a/reference/spl/appenditerator/key.xml b/reference/spl/appenditerator/key.xml new file mode 100644 index 0000000000..f0ddf2f343 --- /dev/null +++ b/reference/spl/appenditerator/key.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::key + Gets the current key + + + + &reftitle.description; + + public voidAppendIterator::key + + + + Get the current key + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current key if it is valid or &null; otherwise. + + + + + &reftitle.seealso; + + + AppendIterator::current + + + + + + + diff --git a/reference/spl/appenditerator/next.xml b/reference/spl/appenditerator/next.xml new file mode 100644 index 0000000000..0b74b830fe --- /dev/null +++ b/reference/spl/appenditerator/next.xml @@ -0,0 +1,67 @@ + + + + + + AppendIterator::next + Moves to the next element + + + + &reftitle.description; + + public voidAppendIterator::next + + + + Moves to the next element. If this means to another Iterator + then it rewinds that Iterator. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + AppendIterator::rewind + + + + + + + diff --git a/reference/spl/appenditerator/rewind.xml b/reference/spl/appenditerator/rewind.xml new file mode 100644 index 0000000000..8084a7cb0c --- /dev/null +++ b/reference/spl/appenditerator/rewind.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::rewind + Rewinds the Iterator + + + + &reftitle.description; + + public voidAppendIterator::rewind + + + + Rewind to the first element of the first inner Iterator. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + AppendIterator::next + + + + + + + diff --git a/reference/spl/appenditerator/valid.xml b/reference/spl/appenditerator/valid.xml new file mode 100644 index 0000000000..90677efdbf --- /dev/null +++ b/reference/spl/appenditerator/valid.xml @@ -0,0 +1,66 @@ + + + + + + AppendIterator::valid + Checks validity of the current element + + + + &reftitle.description; + + public voidAppendIterator::valid + + + + Checks validity of the current element. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + AppendIterator::append + + + + + + + diff --git a/reference/spl/iterators.xml b/reference/spl/iterators.xml index e9cfe22aed..fec72fc6dd 100644 --- a/reference/spl/iterators.xml +++ b/reference/spl/iterators.xml @@ -1,5 +1,5 @@ - + @@ -13,7 +13,6 @@
Undocumented Iterators - AppendIterator EmptyIterator InfiniteIterator MultipleIterator @@ -29,7 +28,6 @@ + &reference.spl.appenditerator; &reference.spl.arrayiterator; &reference.spl.cachingiterator; &reference.spl.directoryiterator;