php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #61705 Incorrect return type documented for CachingIterator->getInnerIterator()
Submitted: 2012-04-12 20:49 UTC Modified: 2012-04-13 08:39 UTC
From: php-tracker at todofixthis dot com Assigned: salathe (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: N/A
Private report: No CVE-ID: None
 [2012-04-12 20:49 UTC] php-tracker at todofixthis dot com
Description:
------------
---
From manual page: http://www.php.net/cachingiterator.getinneriterator#refsect1-
cachingiterator.getinneriterator-description
---

The method signature is documented as:

> public void CachingIterator::getInnerIterator ( void )

This is incorrect; the return type should be `Iterator`, per the documentation in 
the "Return Values" section:

> Returns an object implementing the Iterator interface.

The corrected signature would look like this:

> public Iterator CachingIterator::getInnerIterator ( void )

Test script:
---------------
N/A

Expected result:
----------------
N/A

Actual result:
--------------
N/A

Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2012-04-13 06:46 UTC] aharvey@php.net
-Status: Open +Status: Assigned -Assigned To: +Assigned To: aharvey
 [2012-04-13 06:57 UTC] aharvey@php.net
Automatic comment from SVN on behalf of aharvey
Revision: http://svn.php.net/viewvc/?view=revision&revision=325134
Log: Fix doc bug #61705 (Incorrect return type documented for
CachingIterator->getInnerIterator()).
 [2012-04-13 06:57 UTC] aharvey@php.net
-Status: Assigned +Status: Closed
 [2012-04-13 06:57 UTC] aharvey@php.net
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation better.


 [2012-04-13 08:38 UTC] salathe@php.net
Automatic comment from SVN on behalf of salathe
Revision: http://svn.php.net/viewvc/?view=revision&revision=325140
Log: fix incorrect prototype: Iterator not Traversable (doc #61705)
 [2012-04-13 08:39 UTC] salathe@php.net
-Assigned To: aharvey +Assigned To: salathe
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Fri Apr 26 15:01:56 2024 UTC