Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.0.0b4

Doc Bug #5536 No explanation of properties
Submitted: 2005-09-27 08:20 UTC
From: info at darrencampbell dot com dot au Assigned: cellog
Status: Closed Package: HTTP_Upload
PHP Version: Irrelevant OS: All
Roadmaps: (Not assigned)    
Subscription  
Comments Add Comment Add patch


Anyone can comment on a bug. Have a simpler test case? Does it work for you on a different platform? Let us know! Just going to say 'Me too!'? Don't clutter the database with that please !
Your email address:
MUST BE VALID
Solve the problem : 33 - 11 = ?

 
 [2005-09-27 08:20 UTC] info at darrencampbell dot com dot au
Description: ------------ This is a documentation bug. I am reporting it because one has to inspect the source code to understand which values to use in the getProp() method in order to retrieve the property that one is looking for. The point of using packages is to hide implementation details from the end-user in order to reduce coding effort. Following this line of thought, adequate documentation should be provided to enable easy use of the package without having to examine the intricacies of the package source. Test script: --------------- I looked through the end-user documentation for a list of the properties available through the getProp() method. Expected result: ---------------- I expect to see a list of all the properties that I can retrieve using the getProp() method as well as an explanation of what each property is. Actual result: -------------- Unfortunately, I could not find a list in the end-user documentation. So the actual result is that there is no explanation of what properties are available or what keys to use in the getProp() method to know how to select each property.

Comments

 [2005-09-27 08:26 UTC] info at darrencampbell dot com dot au
I think these are the values. 'real' => $name, 'name' => $name, 'form_name' => $formname, 'ext' => $ext, 'tmp_name' => $tmp, 'size' => $size, 'type' => $type, 'error' => $error Please explain them in the end-user documentation and I think that would resolve this bug.
 [2007-02-01 06:16 UTC] cellog (Greg Beaver)
This bug has been fixed in CVS. If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET). If this was a problem with the pear.php.net website, the change should be live shortly. Otherwise, the fix will appear in the package's next release. Thank you for the report and for helping us make PEAR better.