diff --git a/reference/spl/appenditerator/append.xml b/reference/spl/appenditerator/append.xml index b7efc490f9..3a6042c251 100644 --- a/reference/spl/appenditerator/append.xml +++ b/reference/spl/appenditerator/append.xml @@ -16,9 +16,6 @@ Appends an iterator. - - &warn.undocumented.func; - @@ -44,6 +41,37 @@ + + &reftitle.examples; + + + <methodname>AppendIterator::append</methodname> example + +append($array_a); +$iterator->append($array_b); + +foreach ($iterator as $current) { + echo $current; +} +?> +]]> + + &example.outputs; + + + + + + + &reftitle.seealso; diff --git a/reference/spl/appenditerator/construct.xml b/reference/spl/appenditerator/construct.xml index 496de7c99e..e6b1206ff0 100644 --- a/reference/spl/appenditerator/construct.xml +++ b/reference/spl/appenditerator/construct.xml @@ -47,12 +47,12 @@ $appendIterator->append($pizzas); $appendIterator->append($toppings); foreach ($appendIterator as $key => $item) { - echo "$key => $item", PHP_EOL; + echo $key . ' => ' . $item . PHP_EOL; } ?> ]]> - &example.outputs.similar; + &example.outputs; Margarita @@ -91,7 +91,7 @@ while ($appendIterator->valid()) { ?> ]]> - &example.outputs.similar; + &example.outputs; 0 => Margarita diff --git a/reference/spl/appenditerator/current.xml b/reference/spl/appenditerator/current.xml index ea254fb190..009343b8b4 100644 --- a/reference/spl/appenditerator/current.xml +++ b/reference/spl/appenditerator/current.xml @@ -10,15 +10,12 @@ &reftitle.description; - public voidAppendIterator::current + public mixedAppendIterator::current Gets the current value. - - &warn.undocumented.func; - @@ -37,7 +34,11 @@ &reftitle.seealso; + Iterator::current + AppendIterator::key + AppendIterator::valid AppendIterator::next + AppendIterator::rewind diff --git a/reference/spl/appenditerator/getarrayiterator.xml b/reference/spl/appenditerator/getarrayiterator.xml index 64abae1a15..d9be0bb29a 100644 --- a/reference/spl/appenditerator/getarrayiterator.xml +++ b/reference/spl/appenditerator/getarrayiterator.xml @@ -4,7 +4,7 @@ AppendIterator::getArrayIterator - The getArrayIterator method + Gets the ArrayIterator @@ -14,11 +14,9 @@ - The getArrayIterator method + This method gets the ArrayIterator that is used to + store the iterators added with AppendIterator::append. - - &warn.undocumented.func; - @@ -29,7 +27,8 @@ &reftitle.returnvalues; - + Returns an ArrayIterator containing + the appended iterators. diff --git a/reference/spl/appenditerator/getinneriterator.xml b/reference/spl/appenditerator/getinneriterator.xml index 06f85963c2..485baff57e 100644 --- a/reference/spl/appenditerator/getinneriterator.xml +++ b/reference/spl/appenditerator/getinneriterator.xml @@ -4,21 +4,18 @@ AppendIterator::getInnerIterator - Gets an inner iterator + Gets the inner iterator &reftitle.description; - public voidAppendIterator::getInnerIterator + public IteratorAppendIterator::getInnerIterator - Get an inner iterator + This method returns the current inner iterator. - - &warn.undocumented.func; - @@ -29,15 +26,56 @@ &reftitle.returnvalues; - The current inner Iterator. + The current inner iterator, or &null; if there is not one. + + &reftitle.examples; + + + <methodname>AppendIterator::getInnerIterator</methodname> example + + 'aardwolf', 'b' => 'bear', 'c' => 'capybara')); +$array_b = new RegexIterator($array_a, '/^[ac]/'); + +$iterator = new AppendIterator; +$iterator->append($array_a); +$iterator->append($array_b); + +foreach ($iterator as $current) { + $inner = $iterator->getInnerIterator(); + if ($inner instanceOf RegexIterator) { + echo 'Filtered: '; + } else { + echo 'Original: '; + } + echo $current . PHP_EOL; +} +?> +]]> + + &example.outputs; + + + + + + + &reftitle.seealso; - AppendIterator::getArrayIterator + AppendIterator::getIteratorIndex diff --git a/reference/spl/appenditerator/getiteratorindex.xml b/reference/spl/appenditerator/getiteratorindex.xml index 888f225106..7a13393475 100644 --- a/reference/spl/appenditerator/getiteratorindex.xml +++ b/reference/spl/appenditerator/getiteratorindex.xml @@ -10,15 +10,12 @@ &reftitle.description; - public voidAppendIterator::getIteratorIndex + public intAppendIterator::getIteratorIndex - Get an index of iterators. + Gets the index of the current inner iterator. - - &warn.undocumented.func; - @@ -29,15 +26,54 @@ &reftitle.returnvalues; - The index of iterators. + Returns an integer, which is the zero-based index + of the current inner iterator. + + &reftitle.examples; + + + <methodname>AppendIterator.getIteratorIndex</methodname> basic example + + 'aardwolf', 'b' => 'bear', 'c' => 'capybara')); +$array_b = new ArrayIterator(array('apple', 'orange', 'lemon')); + +$iterator = new AppendIterator; +$iterator->append($array_a); +$iterator->append($array_b); + +foreach ($iterator as $key => $current) { + echo $iterator->getIteratorIndex() . ' ' . $key . ' ' . $current . PHP_EOL; +} +?> +]]> + + &example.outputs; + + + + + + + &reftitle.seealso; AppendIterator::getInnerIterator + AppendIterator::getArrayIterator diff --git a/reference/spl/appenditerator/key.xml b/reference/spl/appenditerator/key.xml index 34896af781..77f70525b7 100644 --- a/reference/spl/appenditerator/key.xml +++ b/reference/spl/appenditerator/key.xml @@ -16,9 +16,6 @@ Get the current key - - &warn.undocumented.func; - @@ -33,11 +30,68 @@ + + &reftitle.examples; + + + <methodname>AppendIterator::key</methodname> basic example + + 'aardwolf', 'b' => 'bear', 'c' => 'capybara')); +$array_b = new ArrayIterator(array('apple', 'orange', 'lemon')); + +$iterator = new AppendIterator; +$iterator->append($array_a); +$iterator->append($array_b); + +// Manual iteration +$iterator->rewind(); +while ($iterator->valid()) { + echo $iterator->key() . ' ' . $iterator->current() . PHP_EOL; + $iterator->next(); +} + +echo PHP_EOL; + +// With foreach +foreach ($iterator as $key => $current) { + echo $key . ' ' . $current . PHP_EOL; +} +?> +]]> + + &example.outputs; + + + + + + + &reftitle.seealso; + Iterator::key AppendIterator::current + AppendIterator::valid + AppendIterator::next + AppendIterator::rewind diff --git a/reference/spl/appenditerator/next.xml b/reference/spl/appenditerator/next.xml index dcf5d12643..07d56e5286 100644 --- a/reference/spl/appenditerator/next.xml +++ b/reference/spl/appenditerator/next.xml @@ -17,9 +17,6 @@ Moves to the next element. If this means to another Iterator then it rewinds that Iterator. - - &warn.undocumented.func; - @@ -38,6 +35,10 @@ &reftitle.seealso; + Iterator::next + AppendIterator::current + AppendIterator::key + AppendIterator::valid AppendIterator::rewind diff --git a/reference/spl/appenditerator/rewind.xml b/reference/spl/appenditerator/rewind.xml index a6632286b2..e527300225 100644 --- a/reference/spl/appenditerator/rewind.xml +++ b/reference/spl/appenditerator/rewind.xml @@ -16,9 +16,6 @@ Rewind to the first element of the first inner Iterator. - - &warn.undocumented.func; - @@ -37,7 +34,11 @@ &reftitle.seealso; + Iterator::rewind + AppendIterator::current + AppendIterator::key AppendIterator::next + AppendIterator::valid diff --git a/reference/spl/appenditerator/valid.xml b/reference/spl/appenditerator/valid.xml index 8a9e074e99..0b23feabf9 100644 --- a/reference/spl/appenditerator/valid.xml +++ b/reference/spl/appenditerator/valid.xml @@ -10,15 +10,12 @@ &reftitle.description; - public voidAppendIterator::valid + public boolAppendIterator::valid Checks validity of the current element. - - &warn.undocumented.func; - @@ -29,7 +26,7 @@ &reftitle.returnvalues; - &return.success; + Returns &true; if the current iteration is valid, &false; otherwise. @@ -37,7 +34,10 @@ &reftitle.seealso; - AppendIterator::append + AppendIterator::current + AppendIterator::key + AppendIterator::next + AppendIterator::rewind