Doc #78258 [Opn]: stream_bucket_new does not have documentation
| From: | requinix@php.net | Date: | Sat, 06 Jul 2019 10:53:51 +0000 |
| Subject: | Doc #78258 [Opn]: stream_bucket_new does not have documentation | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-16803@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=78258&edit=1
ID: 78258
Updated by: requinix@php.net
Reported by: carlosv775 at gmail dot com
-Summary: Besides not having a documentation,
stream_bucket_new signature is wrong.
+Summary: stream_bucket_new does not have documentation
Status: Open
Type: Documentation Problem
-Package: Documentation problem
+Package: Streams related
Operating System: Irrelevant
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
Returning false or null in case of error is common, and by convention the return value documented
with the signature does not include that. Rather, such behavior gets documented in the Return Values
section.
Previous Comments:
------------------------------------------------------------------------
[2019-07-06 08:18:26] carlosv775 at gmail dot com
Description:
------------
---
From manual page: https://php.net/function.stream-bucket-new
---
This page returns FALSE if something goes wrong, for instance, if the stream isn't available.
At least the function's signature should be changed to stream_bucket_new ( resource $stream ,
string $buffer ) : object|bool if no documentation will be written for it.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=78258&edit=1