This commit updates the documentation for the `valid` method of the
following iterators:
- `EmptyIterator` - add a note that this will always return false
- `FilterIterator` - add a note that the value will be false until the
pointer is advanced to the first valid element
- `IteratorIterator` - clarify that the method checks if the element is
valid.
These now match the source.
I have checked other iterators and these seem to be correctly
documented.
It's worth noting that the `ArrayIterator::valid` method behaves
differently - it checks if the next element is valid (confirmed in
source).
The `DirectoryIterator::valid` method may also be incorrectly
documented but I am not 100% sure of this. The documentation states
that the method checks if it is a valid _file_, but I believe that the
method checks if the Iterator element is valid.
Years ago this was `void`, and I erroneously changed it to `scalar`. It will delegate to the sub-iterator's get_current_key handler, which can return any kind of zval.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346694 c90b9560-bf6c-de11-be94-00142212c4b1
still using this, after discussion on the phpdoc list.
From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
