php / php/doc-en

[Docs] `php://input` is reusable

Open Beginner friendly
#4,555 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Affected page

https://github.com/php/doc-en/blob/master/language/wrappers/php.xml

Current issue

In the documentation for "New features" in PHP 5.6 it mentions that "php://input is reusable": "php://input may now be reopened and read as many times as required."

https://github.com/php/doc-en/blob/master/appendices/migration56/new-features.xml

As far as I can see, this doesn't seem to be discussed on the page for php://input, or anywhere else in the documentation?

It seems like this is something that should be mentioned in the main part of the documentation, not just in the PHP 5.6 section. (Especially if the PHP 5.6 section is likely to be removed soon - then it won't be documented anywhere.)

Suggested improvement

I would suggest mentioning this in the page https://github.com/php/doc-en/blob/master/language/wrappers/php.xml - that seems to be the primary location where php://input is documented.

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

Start by reading language/wrappers/php.xml and compare its existing php://input documentation with the PHP 5.6 note in appendices/migration56/new-features.xml. Update the primary php://input documentation to cover its reusability, with wording consistent with the existing documentation; done means this behavior is documented outside the migration page.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.