Doc #53166 [Asn]: ZipArchive::addFile() is missing parameters in docs
| From: | pajoye@php.net | Date: | Tue, 26 Oct 2010 16:30:41 +0000 |
| Subject: | Doc #53166 [Asn]: ZipArchive::addFile() is missing parameters in docs | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-5421@lists.php.net to get a copy of this message | ||
Edit report at http://bugs.php.net/bug.php?id=53166&edit=1
ID: 53166
Updated by: pajoye@php.net
Reported by: znarkus at gmail dot com
Summary: ZipArchive::addFile() is missing parameters in docs
Status: Assigned
Type: Documentation Problem
Package: Zip Related
Operating System: Windows
PHP Version: 5.3.3
Assigned To: pajoye
Block user comment: N
New Comment:
Richard, also please use either the bug tracker or a direct mail, but
not both.
I will look at these as soon as possible (but toooo soon).
Previous Comments:
------------------------------------------------------------------------
[2010-10-26 18:25:45] philip@php.net
Assigning to Pierre, he should help investigate this.
------------------------------------------------------------------------
[2010-10-26 18:18:08] rquadling@php.net
There would also be an issue with ZipArchive::setArchiveComment,
ZipArchive::getCommentIndex, ZipArchive::getCommentName,
ZipArchive::getNameIndex(), ZipArchive::getFromName() and
ZipArchive::getFromIndex().
None of these methods documented prototypes tie up with the actual
parameters being reflected by the extension.
Also, in some cases, the reflection doesn't tie up with the argument
parsing in the C code.
Whilst, on the surface, this looks like a documentation bug, I think
that the underlying code should be fixed and then accurate documentation
can be written from that.
There are also missing function ZipArchive::addGlob() and
ZipArchive::addPattern() are missing.
------------------------------------------------------------------------
[2010-10-26 17:38:24] znarkus at gmail dot com
Yeah, downloading the source and dissecting the C code is probably not
rookie PHP'ers do, like I had to. One of the things PHP is known for is
it's extensive documentation. Thanks for taking the time!
------------------------------------------------------------------------
[2010-10-26 17:33:51] philip@php.net
If the parameters exist, they should be documented, even if it means
saying that
they do nothing useful.
------------------------------------------------------------------------
[2010-10-26 16:51:53] znarkus at gmail dot com
Without them, I get the following error when extending the class.
Declaration of ZipArchiveImproved::addFile() should be compatible with
that of ZipArchive::addFile()
ZipArchiveImproved is my custom class, and definition of addFile is as
follows, which doesn't work.
public function addFile( $fileName, $localname = '')
------------------------------------------------------------------------
The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at
http://bugs.php.net/bug.php?id=53166
--
Edit this bug report at http://bugs.php.net/bug.php?id=53166&edit=1