\GuzzleHttp\Psr7DroppingStream

Stream decorator that begins dropping data once the size of the underlying stream becomes too full.

Summary

Methods
Properties
Constants
__construct()
__get()
__toString()
getContents()
__call()
close()
getMetadata()
detach()
getSize()
eof()
tell()
isReadable()
isWritable()
isSeekable()
rewind()
seek()
read()
write()
No public properties found
No constants found
createStream()
No protected properties found
N/A
No private methods found
$maxLength
N/A

Properties

$maxLength

$maxLength

Methods

__construct()

__construct(\Psr\Http\Message\StreamInterface  $stream, int  $maxLength) : mixed

Parameters

\Psr\Http\Message\StreamInterface $stream

Underlying stream to decorate.

int $maxLength

Maximum size before dropping data.

Returns

mixed —

__get()

__get(string  $name) : \Psr\Http\Message\StreamInterface

Magic method used to create a new stream if streams are not added in the constructor of a decorator (e.g., LazyOpenStream).

Parameters

string $name

Name of the property (allows "stream" only).

Returns

\Psr\Http\Message\StreamInterface —

__toString()

__toString() : mixed

Returns

mixed —

getContents()

getContents() : mixed

Returns

mixed —

__call()

__call(string  $method, array  $args) : mixed

Allow decorators to implement custom methods

Parameters

string $method

Missing method name

array $args

Method arguments

Returns

mixed —

close()

close() : mixed

Returns

mixed —

getMetadata()

getMetadata(mixed  $key = null) : mixed

Parameters

mixed $key

Returns

mixed —

detach()

detach() : mixed

Returns

mixed —

getSize()

getSize() : mixed

Returns

mixed —

eof()

eof() : mixed

Returns

mixed —

tell()

tell() : mixed

Returns

mixed —

isReadable()

isReadable() : mixed

Returns

mixed —

isWritable()

isWritable() : mixed

Returns

mixed —

isSeekable()

isSeekable() : mixed

Returns

mixed —

rewind()

rewind() : mixed

Returns

mixed —

seek()

seek(mixed  $offset, mixed  $whence = SEEK_SET) : mixed

Parameters

mixed $offset
mixed $whence

Returns

mixed —

read()

read(mixed  $length) : mixed

Parameters

mixed $length

Returns

mixed —

write()

write(mixed  $string) : int

Write data to the stream.

Parameters

mixed $string

The string that is to be written.

Returns

int —

Returns the number of bytes written to the stream.

createStream()

createStream() : \Psr\Http\Message\StreamInterface

Implement in subclasses to dynamically create streams when requested.

Throws

\BadMethodCallException

Returns

\Psr\Http\Message\StreamInterface —