From de9c625e7c13ad4f794b391ea6957c21f66087dd Mon Sep 17 00:00:00 2001 From: Nuno Lopes Date: Thu, 6 May 2004 15:04:00 +0000 Subject: [PATCH] more spl protos git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@158093 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../functions/ArrayObject-offsetExists.xml | 42 +++++++++++++++++++ .../spl/functions/ArrayObject-offsetGet.xml | 41 ++++++++++++++++++ .../spl/functions/ArrayObject-offsetSet.xml | 42 +++++++++++++++++++ .../spl/functions/ArrayObject-offsetUnset.xml | 41 ++++++++++++++++++ .../spl/functions/CachingIterator-hasNext.xml | 41 ++++++++++++++++++ .../spl/functions/CachingIterator-next.xml | 41 ++++++++++++++++++ .../spl/functions/CachingIterator-rewind.xml | 41 ++++++++++++++++++ .../functions/CachingIterator-toString.xml | 41 ++++++++++++++++++ .../spl/functions/CachingIterator-valid.xml | 41 ++++++++++++++++++ .../CachingRecursiveIterator-getChildren.xml | 41 ++++++++++++++++++ .../CachingRecursiveIterator-hasChildren.xml | 41 ++++++++++++++++++ .../DirectoryIterator-getChildren.xml | 41 ++++++++++++++++++ ...asMore.xml => DirectoryIterator-valid.xml} | 8 ++-- .../spl/functions/FilterIterator-current.xml | 41 ++++++++++++++++++ .../FilterIterator-getInnerIterator.xml | 41 ++++++++++++++++++ .../spl/functions/FilterIterator-key.xml | 41 ++++++++++++++++++ .../spl/functions/FilterIterator-next.xml | 41 ++++++++++++++++++ .../spl/functions/FilterIterator-rewind.xml | 41 ++++++++++++++++++ .../spl/functions/FilterIterator-valid.xml | 41 ++++++++++++++++++ .../functions/LimitIterator-getPosition.xml | 41 ++++++++++++++++++ .../spl/functions/LimitIterator-next.xml | 41 ++++++++++++++++++ .../spl/functions/LimitIterator-rewind.xml | 41 ++++++++++++++++++ .../spl/functions/LimitIterator-seek.xml | 41 ++++++++++++++++++ .../spl/functions/LimitIterator-valid.xml | 41 ++++++++++++++++++ .../functions/ParentIterator-getChildren.xml | 41 ++++++++++++++++++ .../functions/ParentIterator-hasChildren.xml | 41 ++++++++++++++++++ .../spl/functions/ParentIterator-next.xml | 41 ++++++++++++++++++ .../spl/functions/ParentIterator-rewind.xml | 41 ++++++++++++++++++ .../RecursiveIteratorIterator-current.xml | 41 ++++++++++++++++++ .../RecursiveIteratorIterator-getDepth.xml | 41 ++++++++++++++++++ ...cursiveIteratorIterator-getSubIterator.xml | 41 ++++++++++++++++++ .../RecursiveIteratorIterator-key.xml | 41 ++++++++++++++++++ .../RecursiveIteratorIterator-next.xml | 41 ++++++++++++++++++ .../RecursiveIteratorIterator-rewind.xml | 41 ++++++++++++++++++ .../RecursiveIteratorIterator-valid.xml | 41 ++++++++++++++++++ 35 files changed, 1400 insertions(+), 4 deletions(-) create mode 100755 reference/spl/functions/ArrayObject-offsetExists.xml create mode 100755 reference/spl/functions/ArrayObject-offsetGet.xml create mode 100755 reference/spl/functions/ArrayObject-offsetSet.xml create mode 100755 reference/spl/functions/ArrayObject-offsetUnset.xml create mode 100755 reference/spl/functions/CachingIterator-hasNext.xml create mode 100755 reference/spl/functions/CachingIterator-next.xml create mode 100755 reference/spl/functions/CachingIterator-rewind.xml create mode 100755 reference/spl/functions/CachingIterator-toString.xml create mode 100755 reference/spl/functions/CachingIterator-valid.xml create mode 100755 reference/spl/functions/CachingRecursiveIterator-getChildren.xml create mode 100755 reference/spl/functions/CachingRecursiveIterator-hasChildren.xml create mode 100755 reference/spl/functions/DirectoryIterator-getChildren.xml rename reference/spl/functions/{DirectoryIterator-hasMore.xml => DirectoryIterator-valid.xml} (79%) create mode 100755 reference/spl/functions/FilterIterator-current.xml create mode 100755 reference/spl/functions/FilterIterator-getInnerIterator.xml create mode 100755 reference/spl/functions/FilterIterator-key.xml create mode 100755 reference/spl/functions/FilterIterator-next.xml create mode 100755 reference/spl/functions/FilterIterator-rewind.xml create mode 100755 reference/spl/functions/FilterIterator-valid.xml create mode 100755 reference/spl/functions/LimitIterator-getPosition.xml create mode 100755 reference/spl/functions/LimitIterator-next.xml create mode 100755 reference/spl/functions/LimitIterator-rewind.xml create mode 100755 reference/spl/functions/LimitIterator-seek.xml create mode 100755 reference/spl/functions/LimitIterator-valid.xml create mode 100755 reference/spl/functions/ParentIterator-getChildren.xml create mode 100755 reference/spl/functions/ParentIterator-hasChildren.xml create mode 100755 reference/spl/functions/ParentIterator-next.xml create mode 100755 reference/spl/functions/ParentIterator-rewind.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-current.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-getDepth.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-getSubIterator.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-key.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-next.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-rewind.xml create mode 100755 reference/spl/functions/RecursiveIteratorIterator-valid.xml diff --git a/reference/spl/functions/ArrayObject-offsetExists.xml b/reference/spl/functions/ArrayObject-offsetExists.xml new file mode 100755 index 0000000000..8e8d1aef6e --- /dev/null +++ b/reference/spl/functions/ArrayObject-offsetExists.xml @@ -0,0 +1,42 @@ + + + + + ArrayObject::offsetExists + + proto bool ArrayIterator::offsetExists(mixed $index) + Returns whether the requested $index exists. + + + + Description + + boolArrayObject::offsetExists + mixed$index + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ArrayObject-offsetGet.xml b/reference/spl/functions/ArrayObject-offsetGet.xml new file mode 100755 index 0000000000..2014788a55 --- /dev/null +++ b/reference/spl/functions/ArrayObject-offsetGet.xml @@ -0,0 +1,41 @@ + + + + + ArrayObject::offsetGet + + Returns the value at the specified $index. + + + + Description + + boolArrayObject::offsetGet + mixed$index + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ArrayObject-offsetSet.xml b/reference/spl/functions/ArrayObject-offsetSet.xml new file mode 100755 index 0000000000..55cb827cc4 --- /dev/null +++ b/reference/spl/functions/ArrayObject-offsetSet.xml @@ -0,0 +1,42 @@ + + + + + ArrayObject::offsetSet + + Sets the value at the specified $index to $newval. + + + + Description + + voidArrayObject::offsetSet + mixed$index + mixed$newval + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ArrayObject-offsetUnset.xml b/reference/spl/functions/ArrayObject-offsetUnset.xml new file mode 100755 index 0000000000..1a4ba9acb3 --- /dev/null +++ b/reference/spl/functions/ArrayObject-offsetUnset.xml @@ -0,0 +1,41 @@ + + + + + ArrayObject::offsetUnset + + Unsets the value at the specified $index. + + + + Description + + voidArrayObject::offsetUnset + mixed$index + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingIterator-hasNext.xml b/reference/spl/functions/CachingIterator-hasNext.xml new file mode 100755 index 0000000000..bae78dd833 --- /dev/null +++ b/reference/spl/functions/CachingIterator-hasNext.xml @@ -0,0 +1,41 @@ + + + + + CachingIterator::hasNext + + Cehck whether the inner iterator has a valid next element + + + + Description + + booleanCachingIterator::hasNext + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingIterator-next.xml b/reference/spl/functions/CachingIterator-next.xml new file mode 100755 index 0000000000..9a8877a506 --- /dev/null +++ b/reference/spl/functions/CachingIterator-next.xml @@ -0,0 +1,41 @@ + + + + + CachingIterator::next + + Move the iterator forward + + + + Description + + voidCachingIterator::next + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingIterator-rewind.xml b/reference/spl/functions/CachingIterator-rewind.xml new file mode 100755 index 0000000000..b84b57809c --- /dev/null +++ b/reference/spl/functions/CachingIterator-rewind.xml @@ -0,0 +1,41 @@ + + + + + CachingIterator::rewind + + Rewind the iterator + + + + Description + + voidCachingIterator::rewind + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingIterator-toString.xml b/reference/spl/functions/CachingIterator-toString.xml new file mode 100755 index 0000000000..5f2501aaa5 --- /dev/null +++ b/reference/spl/functions/CachingIterator-toString.xml @@ -0,0 +1,41 @@ + + + + + CachingIterator::__toString + + Retrun the string representation of the current element + + + + Description + + stringCachingIterator::__toString + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingIterator-valid.xml b/reference/spl/functions/CachingIterator-valid.xml new file mode 100755 index 0000000000..d4bc393c29 --- /dev/null +++ b/reference/spl/functions/CachingIterator-valid.xml @@ -0,0 +1,41 @@ + + + + + CachingIterator::valid + + Check whether the current element is valid + + + + Description + + booleanCachingIterator::valid + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingRecursiveIterator-getChildren.xml b/reference/spl/functions/CachingRecursiveIterator-getChildren.xml new file mode 100755 index 0000000000..918f221968 --- /dev/null +++ b/reference/spl/functions/CachingRecursiveIterator-getChildren.xml @@ -0,0 +1,41 @@ + + + + + CachingRecursiveIterator::getChildren + + Return the inenr iteraor's children as a CachingRecursiveIterator + + + + Description + + CachingRecursiveIteratorCachingRecursiveIterator::getChildren + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/CachingRecursiveIterator-hasChildren.xml b/reference/spl/functions/CachingRecursiveIterator-hasChildren.xml new file mode 100755 index 0000000000..89634f00da --- /dev/null +++ b/reference/spl/functions/CachingRecursiveIterator-hasChildren.xml @@ -0,0 +1,41 @@ + + + + + CachingRecursiveIterator::hasChildren + + Cehck whether the current element of the inner iterator has children + + + + Description + + boleanCachingRecursiveIterator::hasChildren + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/DirectoryIterator-getChildren.xml b/reference/spl/functions/DirectoryIterator-getChildren.xml new file mode 100755 index 0000000000..2bb6f8809b --- /dev/null +++ b/reference/spl/functions/DirectoryIterator-getChildren.xml @@ -0,0 +1,41 @@ + + + + + DirectoryIterator::getChildren + + Returns an iterator for the current entry if it is a directory + + + + Description + + RecursiveDirectoryIteratorDirectoryIterator::getChildren + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/DirectoryIterator-hasMore.xml b/reference/spl/functions/DirectoryIterator-valid.xml similarity index 79% rename from reference/spl/functions/DirectoryIterator-hasMore.xml rename to reference/spl/functions/DirectoryIterator-valid.xml index 11880dc522..d1d662e35b 100755 --- a/reference/spl/functions/DirectoryIterator-hasMore.xml +++ b/reference/spl/functions/DirectoryIterator-valid.xml @@ -1,8 +1,8 @@ - - + + - DirectoryIterator::hasMore + DirectoryIterator::valid Check whether dir contains more entries @@ -10,7 +10,7 @@ Description - stringDirectoryIterator::hasMore + stringDirectoryIterator::valid diff --git a/reference/spl/functions/FilterIterator-current.xml b/reference/spl/functions/FilterIterator-current.xml new file mode 100755 index 0000000000..ab6816fe3a --- /dev/null +++ b/reference/spl/functions/FilterIterator-current.xml @@ -0,0 +1,41 @@ + + + + + FilterIterator::current + + Get the current element value + + + + Description + + mixedFilterIterator::current + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/FilterIterator-getInnerIterator.xml b/reference/spl/functions/FilterIterator-getInnerIterator.xml new file mode 100755 index 0000000000..a011ca7e94 --- /dev/null +++ b/reference/spl/functions/FilterIterator-getInnerIterator.xml @@ -0,0 +1,41 @@ + + + + + FilterIterator::getInnerIterator + + Get the inner iterator + + + + Description + + IteratorFilterIterator::getInnerIterator + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/FilterIterator-key.xml b/reference/spl/functions/FilterIterator-key.xml new file mode 100755 index 0000000000..fc7dc84d82 --- /dev/null +++ b/reference/spl/functions/FilterIterator-key.xml @@ -0,0 +1,41 @@ + + + + + FilterIterator::key + + Get the current key + + + + Description + + mixedFilterIterator::key + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/FilterIterator-next.xml b/reference/spl/functions/FilterIterator-next.xml new file mode 100755 index 0000000000..8d4fc0b77a --- /dev/null +++ b/reference/spl/functions/FilterIterator-next.xml @@ -0,0 +1,41 @@ + + + + + FilterIterator::next + + Move the iterator forward + + + + Description + + voidFilterIterator::next + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/FilterIterator-rewind.xml b/reference/spl/functions/FilterIterator-rewind.xml new file mode 100755 index 0000000000..44d30a350c --- /dev/null +++ b/reference/spl/functions/FilterIterator-rewind.xml @@ -0,0 +1,41 @@ + + + + + FilterIterator::rewind + + Rewind the iterator + + + + Description + + voidFilterIterator::rewind + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/FilterIterator-valid.xml b/reference/spl/functions/FilterIterator-valid.xml new file mode 100755 index 0000000000..d15d5794b4 --- /dev/null +++ b/reference/spl/functions/FilterIterator-valid.xml @@ -0,0 +1,41 @@ + + + + + FilterIterator::valid + + Check whether the current element is valid + + + + Description + + booleanFilterIterator::valid + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/LimitIterator-getPosition.xml b/reference/spl/functions/LimitIterator-getPosition.xml new file mode 100755 index 0000000000..0b005ef963 --- /dev/null +++ b/reference/spl/functions/LimitIterator-getPosition.xml @@ -0,0 +1,41 @@ + + + + + LimitIterator::getPosition + + Return the current position + + + + Description + + intLimitIterator::getPosition + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/LimitIterator-next.xml b/reference/spl/functions/LimitIterator-next.xml new file mode 100755 index 0000000000..26bbdae022 --- /dev/null +++ b/reference/spl/functions/LimitIterator-next.xml @@ -0,0 +1,41 @@ + + + + + LimitIterator::next + + Move the iterator forward + + + + Description + + voidLimitIterator::next + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/LimitIterator-rewind.xml b/reference/spl/functions/LimitIterator-rewind.xml new file mode 100755 index 0000000000..3c23488d77 --- /dev/null +++ b/reference/spl/functions/LimitIterator-rewind.xml @@ -0,0 +1,41 @@ + + + + + LimitIterator::rewind + + Rewind the iterator to the specified starting offset + + + + Description + + voidLimitIterator::rewind + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/LimitIterator-seek.xml b/reference/spl/functions/LimitIterator-seek.xml new file mode 100755 index 0000000000..0c4487a59d --- /dev/null +++ b/reference/spl/functions/LimitIterator-seek.xml @@ -0,0 +1,41 @@ + + + + + LimitIterator::seek + + Seek to the given position + + + + Description + + voidLimitIterator::seek + intposition + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/LimitIterator-valid.xml b/reference/spl/functions/LimitIterator-valid.xml new file mode 100755 index 0000000000..50fd1662df --- /dev/null +++ b/reference/spl/functions/LimitIterator-valid.xml @@ -0,0 +1,41 @@ + + + + + LimitIterator::valid + + Check whether the current element is valid + + + + Description + + booleanLimitIterator::valid + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ParentIterator-getChildren.xml b/reference/spl/functions/ParentIterator-getChildren.xml new file mode 100755 index 0000000000..999bfb5615 --- /dev/null +++ b/reference/spl/functions/ParentIterator-getChildren.xml @@ -0,0 +1,41 @@ + + + + + ParentIterator::getChildren + + Return the inner iterator's children contained in a ParentIterator + + + + Description + + ParentIteratorParentIterator::getChildren + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ParentIterator-hasChildren.xml b/reference/spl/functions/ParentIterator-hasChildren.xml new file mode 100755 index 0000000000..285096676a --- /dev/null +++ b/reference/spl/functions/ParentIterator-hasChildren.xml @@ -0,0 +1,41 @@ + + + + + ParentIterator::hasChildren + + Check whether the inner iterator's current element has children + + + + Description + + booleanParentIterator::hasChildren + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ParentIterator-next.xml b/reference/spl/functions/ParentIterator-next.xml new file mode 100755 index 0000000000..4dbe528663 --- /dev/null +++ b/reference/spl/functions/ParentIterator-next.xml @@ -0,0 +1,41 @@ + + + + + ParentIterator::next + + Move the iterator forward + + + + Description + + voidParentIterator::next + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/ParentIterator-rewind.xml b/reference/spl/functions/ParentIterator-rewind.xml new file mode 100755 index 0000000000..40ab95916d --- /dev/null +++ b/reference/spl/functions/ParentIterator-rewind.xml @@ -0,0 +1,41 @@ + + + + + ParentIterator::rewind + + Rewind the iterator + + + + Description + + voidParentIterator::rewind + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-current.xml b/reference/spl/functions/RecursiveIteratorIterator-current.xml new file mode 100755 index 0000000000..342e3af4cf --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-current.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::current + + Access the current element value + + + + Description + + mixedRecursiveIteratorIterator::current + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-getDepth.xml b/reference/spl/functions/RecursiveIteratorIterator-getDepth.xml new file mode 100755 index 0000000000..b6a49d53b1 --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-getDepth.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::getDepth + + Get the current depth of the recursive iteration + + + + Description + + intRecursiveIteratorIterator::getDepth + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-getSubIterator.xml b/reference/spl/functions/RecursiveIteratorIterator-getSubIterator.xml new file mode 100755 index 0000000000..30fd37e2ed --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-getSubIterator.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::getSubIterator + + The current active sub iterator + + + + Description + + RecursiveIteratorRecursiveIteratorIterator::getSubIterator + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-key.xml b/reference/spl/functions/RecursiveIteratorIterator-key.xml new file mode 100755 index 0000000000..1ae74c07f9 --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-key.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::key + + Access the current key + + + + Description + + mixedRecursiveIteratorIterator::key + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-next.xml b/reference/spl/functions/RecursiveIteratorIterator-next.xml new file mode 100755 index 0000000000..c1370ad062 --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-next.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::next + + Move forward to the next element + + + + Description + + voidRecursiveIteratorIterator::next + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-rewind.xml b/reference/spl/functions/RecursiveIteratorIterator-rewind.xml new file mode 100755 index 0000000000..89c5d37465 --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-rewind.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::rewind + + Rewind the iterator to the first element of the top level inner iterator. + + + + Description + + voidRecursiveIteratorIterator::rewind + + + + &warn.undocumented.func; + + + + + diff --git a/reference/spl/functions/RecursiveIteratorIterator-valid.xml b/reference/spl/functions/RecursiveIteratorIterator-valid.xml new file mode 100755 index 0000000000..66be4aad83 --- /dev/null +++ b/reference/spl/functions/RecursiveIteratorIterator-valid.xml @@ -0,0 +1,41 @@ + + + + + RecursiveIteratorIterator::valid + + Check whether the current position is valid + + + + Description + + boleanRecursiveIteratorIterator::valid + + + + &warn.undocumented.func; + + + + +