\GuzzleHttp\Psr7NoSeekStream

Stream decorator that prevents a stream from being seeked

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
No private properties found
N/A

Methods

__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() 

getContents()

getContents() 

__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() 

getMetadata()

getMetadata(  $key = null) 

Parameters

$key

detach()

detach() 

getSize()

getSize() 

eof()

eof() 

tell()

tell() 

isReadable()

isReadable() 

isWritable()

isWritable() 

isSeekable()

isSeekable() : boolean

Returns whether or not the stream is seekable.

Returns

boolean

rewind()

rewind() 

seek()

seek(integer  $offset, integer  $whence = SEEK_SET) 

Seek to a position in the stream.

Parameters

integer $offset

Stream offset

integer $whence

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.

read()

read(  $length) 

Parameters

$length

write()

write(  $string) 

Parameters

$string

createStream()

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

Implement in subclasses to dynamically create streams when requested.

Throws

\BadMethodCallException

Returns

\Psr\Http\Message\StreamInterface