#32499 [Opn->Csd]: resource context not documented in file_get_contents, file, readfile
| From: | vrana@php.net | Date: | Thu, 31 Mar 2005 15:02:11 +0000 |
| Subject: | #32499 [Opn->Csd]: resource context not documented in file_get_contents, file, readfile | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969367780@lists.php.net to get a copy of this message | ||
ID: 32499
Updated by: vrana@php.net
Reported By: csaba at alum dot mit dot edu
-Status: Open
+Status: Closed
Bug Type: Documentation problem
Operating System: irrelevant
PHP Version: 5CVS-2005-03-30 (dev)
New Comment:
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.
Previous Comments:
------------------------------------------------------------------------
[2005-03-30 12:18:02] csaba at alum dot mit dot edu
Description:
------------
There are a huge lot of file functions (e.g. file_put_contents,
file_get_contents, file, readfile, etc.) that take a 'resource context'
argument, but I don't find this documented under the manual entry for
the individual functions, nor under the File system entry
(http://at.php.net/manual/en/ref.filesystem.php), nor does google.com
show an obvious location for it when I put in "resource context" and
tell PHP to search within the online documentation.
This might not be such an issue, but file_get_contents take additional
arguments (offset, maxlen) AFTER the resource context and there isn't
even an example for the default to use. Nor is there mention of the
type (eg. string) that this argument should be.
There is mention of Stream contexts at http://at2.php.net/stream but a
reasonable person reading through would have to conclude that they are
different animals since the function documentation so consistently
sticks with 'resource context' whereas the streams section talks
exclusively about 'stream context'.
Furthermore, the example (number 2 at the link above) cited at
http://bugs.php.net/bug.php?id=27628&edit=2
does not directly address
this either
Csaba Gabor from Vienna
Expected result:
----------------
It would be nice to have a link to the centralized documentation for
'resource context' along with an example
------------------------------------------------------------------------
--
Edit this bug report at http://bugs.php.net/?id=32499&edit=1