php / php/doc-en

The flag `STREAM_REPORT_ERRORS` is never sent to the `StreamWrapper`

Open
#3,010 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Category: Streams
Dominant language
XML
Stars
596
Forks
890
Avg merge
1d 15h
Merged PRs (30d)
55

Description

As I understand it, since https://github.com/php/php-src/pull/6190, the flag STREAM_REPORT_ERRORS is never sent to the StreamWrapper instances.

The documentation should be updated, as it is not necessary to have code that handle this flag.
https://github.com/php/doc-en/blob/21191d3f9d170c8e9589ca670d1cda9f23e07ac4/reference/stream/streamwrapper/stream-open.xml#L79-L84

https://github.com/php/doc-en/blob/21191d3f9d170c8e9589ca670d1cda9f23e07ac4/reference/stream/constants.xml#L80-L85

What should be the best practice when implementing a StreamWrapper, in case of error? Returning false silently, trigger a E_USER_ERROR or throwing an exception?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read PHP pull request 6190 and compare the guidance in reference/stream/streamwrapper/stream-open.xml lines 79-84 with reference/stream/constants.xml lines 80-85. Update both sections to reflect how STREAM_REPORT_ERRORS is handled and document the expected StreamWrapper error behavior; done means the guidance is consistent and no longer requires handling an unsent flag.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.