streamWrapper::stream_read

Read from stream

&reftitle.description; public ``string``false```streamWrapper::stream_read` `int` `count`

This method is called in response to `fread` and `fgets`.

Remember to update the read/write position of the stream (by the number of bytes that were successfully read).

&reftitle.parameters;

`count`

- How many bytes of data from the current position should be returned.

&reftitle.returnvalues;

If there are less than `count` bytes available, as many as are available should be returned. If no more data is available, an empty string should be returned. To signal that reading failed, &false; should be returned.

&reftitle.errors; &userstream.not.implemented.warning;

If the return value is longer then `count` an `E_WARNING` error will be emitted, and excess data will be lost.

&reftitle.notes;

`streamWrapper::stream_eof` is called directly after calling `streamWrapper::stream_read` to check if EOF has been reached. If not implemented, EOF is assumed.

When reading the whole file (for example, with `file_get_contents`), PHP will call `streamWrapper::stream_read` followed by `streamWrapper::stream_eof` in a loop but as long as `streamWrapper::stream_read` returns a non-empty string, the return value of `streamWrapper::stream_eof` is ignored.

&reftitle.seealso;

- `fread`
- `fgets`