copyToStream(\Psr\Http\Message\StreamInterface $source, \Psr\Http\Message\StreamInterface $dest, integer $maxLen = -1)
Copy the contents of a stream into another stream until the given number of bytes have been read.
| \Psr\Http\Message\StreamInterface | $source | Stream to read from |
| \Psr\Http\Message\StreamInterface | $dest | Stream to write to |
| integer | $maxLen | Maximum number of bytes to read. Pass -1 to read the entire stream. |
on error.
copyToString(\Psr\Http\Message\StreamInterface $stream, integer $maxLen = -1) : string
Copy the contents of a stream into a string until the given number of bytes have been read.
| \Psr\Http\Message\StreamInterface | $stream | Stream to read |
| integer | $maxLen | Maximum number of bytes to read. Pass -1 to read the entire stream. |
on error.
hash(\Psr\Http\Message\StreamInterface $stream, string $algo, boolean $rawOutput = false) : string
Calculate a hash of a stream.
This method reads the entire stream to calculate a rolling hash, based
on PHP's hash_init functions.
| \Psr\Http\Message\StreamInterface | $stream | Stream to calculate the hash for |
| string | $algo | Hash algorithm (e.g. md5, crc32, etc) |
| boolean | $rawOutput | Whether or not to use raw output |
on error.
Returns the hash of the stream
modifyRequest(\Psr\Http\Message\RequestInterface $request, array $changes) : \Psr\Http\Message\RequestInterface
Clone and modify a request with the given changes.
This method is useful for reducing the number of clones needed to mutate a message.
The changes can be one of:
| \Psr\Http\Message\RequestInterface | $request | Request to clone and modify. |
| array | $changes | Changes to apply. |
readLine(\Psr\Http\Message\StreamInterface $stream, integer|null $maxLength = null) : string
Read a line from the stream up to the maximum allowed buffer length.
| \Psr\Http\Message\StreamInterface | $stream | Stream to read from |
| integer|null | $maxLength | Maximum buffer length |
streamFor(resource|string|null|integer|float|boolean|\Psr\Http\Message\StreamInterface|callable|\Iterator $resource = '', array $options = array()) : \Psr\Http\Message\StreamInterface
Create a new stream based on the input type.
Options is an associative array that can contain the following keys:
This method accepts the following $resource types:
Psr\Http\Message\StreamInterface: Returns the value as-is.string: Creates a stream object that uses the given string as the contents.resource: Creates a stream object that wraps the given PHP stream resource.Iterator: If the provided value implements Iterator, then a read-only
stream object will be created that wraps the given iterable. Each time the
stream is read from, data from the iterator will fill a buffer and will be
continuously called until the buffer is equal to the requested read size.
Subsequent read calls will first read from the buffer and then call next
on the underlying iterator until it is exhausted.object with __toString(): If the object has the __toString() method,
the object will be cast to a string and then a stream will be returned that
uses the string value.NULL: When null is passed, an empty stream object is returned.callable When a callable is passed, a read-only stream object will be
created that invokes the given callable. The callable is invoked with the
number of suggested bytes to read. The callable can return any number of
bytes, but MUST return false when there is no more data to return. The
stream object that wraps the callable will invoke the callable until the
number of requested bytes are available. Any additional bytes will be
buffered and used in subsequent reads.| resource|string|null|integer|float|boolean|\Psr\Http\Message\StreamInterface|callable|\Iterator | $resource | Entity body data |
| array | $options | Additional options |
if the $resource arg is not valid.
tryFopen(string $filename, string $mode) : resource
Safely opens a PHP stream resource using a filename.
When fopen fails, PHP normally raises a warning. This function adds an error handler that checks for errors and throws an exception instead.
| string | $filename | File to open |
| string | $mode | Mode used to open the file |
if the file cannot be opened
uriFor(string|\Psr\Http\Message\UriInterface $uri) : \Psr\Http\Message\UriInterface
Returns a UriInterface for the given value.
This function accepts a string or UriInterface and returns a UriInterface for the given value. If the value is already a UriInterface, it is returned as-is.
| string|\Psr\Http\Message\UriInterface | $uri |