1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 15:52:15 +01:00
Commit Graph

9 Commits

Author SHA1 Message Date
Andrew Lyons
8230e70922 Clarify usage of Iterator::valid methods (#3292)
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.
2024-03-28 22:57:53 +01:00
Máté Kocsis
d51166ca16 Add ext/spl methodsynopsis roles (#2073) 2022-12-13 10:33:30 +01:00
Máté Kocsis
5764345c86 Update some newly clarified types (#1946) 2022-11-07 06:01:12 +01:00
Máté Kocsis
4c0d1f0934 Regenerate ext/spl method synopses based on stubs (#1273)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
2021-12-28 18:34:24 +01:00
Máté Kocsis
60809ebcf7 Generate ext/spl methodsynopses based on stubs (#624) 2021-08-11 23:44:41 +02:00
Thomas Punt
8265cab125 Resolve doc bug #71324
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338453 c90b9560-bf6c-de11-be94-00142212c4b1
2016-01-10 16:49:58 +00:00
Torben Wilson
af4410a7e1 Normalized the sgml-default-dtd-file local-variable line for those
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
2009-09-25 07:04:39 +00:00
Nilgün Belma Bugüner
e3d8be23f8 fixed properties
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283837 c90b9560-bf6c-de11-be94-00142212c4b1
2009-07-11 08:59:47 +00:00
Philip Olson
fcc98f787f added doc skeleton for emptyIterator
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283084 c90b9560-bf6c-de11-be94-00142212c4b1
2009-06-30 00:35:01 +00:00