Implementation of PSR HTTP streams.
This differs from Laminas\Diactoros\Callback stream in that it allows the use of echo
inside the callback, and gracefully handles the callback not returning a string.
Ideally we can amend/update diactoros, but we need to figure that out with the diactoros project. Until then we'll use this shim to provide backwards compatibility with existing CakePHP apps.
callable|null
__construct(callable $callback)
callable
$callback Laminas\Diactoros\Exception\InvalidArgumentException
__toString()
Reads all data from the stream into a string, from the beginning to end.
This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.
Warning: This could attempt to load a large amount of data into memory.
This method MUST NOT raise an exception in order to conform with PHP's string casting operations.
string
attach(callable $callback)
Attach a new callback to the instance.
callable
$callback close()
Closes the stream and any underlying resources.
detach()
Separates any underlying resources from the stream.
After the stream has been detached, the stream is in an unusable state.
resource|null
Underlying PHP stream, if any
eof()
Returns true if the stream is at the end of the stream.
bool
getContents()
Returns the remaining contents in a string
string
RuntimeException
getMetadata(mixed $key)
Get stream metadata as an associative array or retrieve a specific key.
The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.
string
$key optional Specific metadata to retrieve.
array|mixed|null
Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.
getSize()
Get the size of the stream if known.
int|null
Returns the size in bytes if known, or null if unknown.
isReadable()
Returns whether or not the stream is readable.
bool
isSeekable()
Returns whether or not the stream is seekable.
bool
isWritable()
Returns whether or not the stream is writable.
bool
read(mixed $length)
Read data from the stream.
int
$length Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.
string
Returns the data read from the stream, or an empty string if no bytes are available.
RuntimeException
rewind()
Seek to the beginning of the stream.
If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).
RuntimeException
seek(mixed $offset, mixed $whence)
Seek to a position in the stream.
int
$offset Stream offset
int
$whence optional Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek()
. SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset.
RuntimeException
tell()
Returns the current position of the file read/write pointer
int
Position of the file pointer
RuntimeException
write(mixed $string)
Write data to the stream.
string
$string The string that is to be written.
int
Returns the number of bytes written to the stream.
RuntimeException
callable|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Http.CallbackStream.html