Doc #67379 [Asn->Opn]: Not all implemented methods documented for some iterators
| From: | kalle@php.net | Date: | Tue, 24 Oct 2017 08:13:15 +0000 |
| Subject: | Doc #67379 [Asn->Opn]: Not all implemented methods documented for some iterators | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-15158@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=67379&edit=1
ID: 67379
Updated by: kalle@php.net
Reported by: phpbugs at geniusdex dot net
Summary: Not all implemented methods documented for some
iterators
-Status: Assigned
+Status: Open
Type: Documentation Problem
Package: Documentation problem
PHP Version: Irrelevant
-Assigned To: salathe
+Assigned To:
Block user comment: N
Private report: N
Previous Comments:
------------------------------------------------------------------------
[2014-06-04 09:22:12] salathe@php.net
I think I see the problem. We only list inherited methods for one level of the inheritance tree.
Take, for example, GlobIterator. We show its methods, and under "Inherited Methods" we
list the methods its parent class (FilesystemIterator) implements.
We currently do not list methods inherited from grandparent classes. In this case, that would be
DirectoryIterator, which is where the valid() method is implemented.
Perhaps we should convert this ticket to a feature request to list all inherited methods on each
class's synopsis page.
------------------------------------------------------------------------
[2014-06-04 08:08:27] phpbugs at geniusdex dot net
Description:
------------
The documentation for some iterators does not contain all implemented methods. For example, the
documentation for the following iterators do not include the valid() method, which is a required
part of the Iterator interface:
- GlobIterator
- ParentIterator
- RecursiveCallbackFilterIterator
- RecursiveDirectoryIterator
- RecursiveRegexIterator
- RegexIterator
- RecursiveDirectoryIterator
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=67379&edit=1