diff --git a/reference/spl/norewinditerator/construct.xml b/reference/spl/norewinditerator/construct.xml new file mode 100644 index 0000000000..741ab12e88 --- /dev/null +++ b/reference/spl/norewinditerator/construct.xml @@ -0,0 +1,119 @@ + + + + + + NoRewindIterator::__construct + Construct a NoRewindIterator + + + + &reftitle.description; + + NoRewindIterator::__construct + Iteratoriterator + + + Constructs a NoRewindIterator. + + + + + &reftitle.parameters; + + + + iterator + + + The iterator being used. + + + + + + + + + &reftitle.returnvalues; + + A NoRewindIterator based on the passed in + iterator. + + + + + &reftitle.examples; + + + <methodname>NoRewindIterator::__construct</methodname> example + + The second loop does not output because the iterator is only used once, + as it does not rewind. + + +getIterator()); + +echo "Fruit A:\n"; +foreach( $it as $item ) { + echo $item . "\n"; +} + +echo "Fruit B:\n"; +foreach( $it as $item ) { + echo $item . "\n"; +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + + &reftitle.seealso; + + + NoRewindIterator::valid + + + + + + + diff --git a/reference/spl/norewinditerator/current.xml b/reference/spl/norewinditerator/current.xml new file mode 100644 index 0000000000..a24b51a7b3 --- /dev/null +++ b/reference/spl/norewinditerator/current.xml @@ -0,0 +1,66 @@ + + + + + + NoRewindIterator::current + Get the current value + + + + &reftitle.description; + + public mixedNoRewindIterator::current + + + + Gets the current value. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current value. + + + + + &reftitle.seealso; + + + NoRewindIterator::key + + + + + + + diff --git a/reference/spl/norewinditerator/getinneriterator.xml b/reference/spl/norewinditerator/getinneriterator.xml new file mode 100644 index 0000000000..5fa5ae7616 --- /dev/null +++ b/reference/spl/norewinditerator/getinneriterator.xml @@ -0,0 +1,66 @@ + + + + + + NoRewindIterator::getInnerIterator + Get the inner iterator + + + + &reftitle.description; + + public iteratorNoRewindIterator::getInnerIterator + + + + Gets the inner iterator, that was passed in to NoRewindIterator. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The inner iterator, as passed to NoRewindIterator::__construct. + + + + + &reftitle.seealso; + + + NoRewindIterator::valid + + + + + + + diff --git a/reference/spl/norewinditerator/key.xml b/reference/spl/norewinditerator/key.xml new file mode 100644 index 0000000000..d20a18d197 --- /dev/null +++ b/reference/spl/norewinditerator/key.xml @@ -0,0 +1,66 @@ + + + + + + NoRewindIterator::key + Get the current key + + + + &reftitle.description; + + public mixedNoRewindIterator::key + + + + Gets the current key. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The current key. + + + + + &reftitle.seealso; + + + NoRewindIterator::next + + + + + + + diff --git a/reference/spl/norewinditerator/next.xml b/reference/spl/norewinditerator/next.xml new file mode 100644 index 0000000000..4d3138c688 --- /dev/null +++ b/reference/spl/norewinditerator/next.xml @@ -0,0 +1,66 @@ + + + + + + NoRewindIterator::next + Forward to the next element + + + + &reftitle.description; + + public voidNoRewindIterator::next + + + + Forwards to the next element. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.seealso; + + + NoRewindIterator::rewind + + + + + + + diff --git a/reference/spl/norewinditerator/valid.xml b/reference/spl/norewinditerator/valid.xml new file mode 100644 index 0000000000..f15c571b2c --- /dev/null +++ b/reference/spl/norewinditerator/valid.xml @@ -0,0 +1,66 @@ + + + + + + NoRewindIterator::valid + Validates the iterator + + + + &reftitle.description; + + public boolNoRewindIterator::valid + + + + Checks whether the iterator is valid. + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + NoRewindIterator::getInnerIterator + + + + + + +