\PhpZip\IO\StreamResponseStream

Implement PSR Message Stream.

Summary

Methods
Properties
Constants
__construct()
getMetadata()
__toString()
rewind()
getSize()
tell()
eof()
isSeekable()
seek()
isWritable()
write()
isReadable()
read()
getContents()
__destruct()
close()
detach()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$readWriteHash
$stream
$size
$seekable
$readable
$writable
$uri
N/A

Properties

$readWriteHash

$readWriteHash : array

Type

array

$stream

$stream : resource

Type

resource

$size

$size : int|null

Type

int|null

$seekable

$seekable : bool

Type

bool

$readable

$readable : bool

Type

bool

$writable

$writable : bool

Type

bool

Methods

__construct()

__construct(resource  $stream) : mixed

Parameters

resource $stream

stream resource to wrap

Throws

\InvalidArgumentException

if the stream is not a stream resource

Returns

mixed —

getMetadata()

getMetadata(string  $key = null) : array|mixed|null

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.

Parameters

string $key

specific metadata to retrieve

Returns

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.

__toString()

__toString() : string

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.

Returns

string —

rewind()

rewind() : mixed

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).

Throws

\RuntimeException

on failure

Returns

mixed —

getSize()

getSize() : int|null

Get the size of the stream if known.

Returns

int|null —

returns the size in bytes if known, or null if unknown

tell()

tell() : int

Returns the current position of the file read/write pointer.

Throws

\RuntimeException

on error

Returns

int —

Position of the file pointer

eof()

eof() : bool

Returns true if the stream is at the end of the stream.

Returns

bool —

isSeekable()

isSeekable() : bool

Returns whether or not the stream is seekable.

Returns

bool —

seek()

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

Seek to a position in the stream.

Parameters

int $offset

Stream offset

int $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.

Throws

\RuntimeException

on failure

Returns

mixed —

isWritable()

isWritable() : bool

Returns whether or not the stream is writable.

Returns

bool —

write()

write(string  $string) : int

Write data to the stream.

Parameters

string $string

the string that is to be written

Throws

\RuntimeException

on failure

Returns

int —

returns the number of bytes written to the stream

isReadable()

isReadable() : bool

Returns whether or not the stream is readable.

Returns

bool —

read()

read(int  $length) : string

Read data from the stream.

Parameters

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.

Throws

\RuntimeException

if an error occurs

Returns

string —

returns the data read from the stream, or an empty string if no bytes are available

getContents()

getContents() : string

Returns the remaining contents in a string.

Throws

\RuntimeException

if unable to read or an error occurs while reading

Returns

string —

__destruct()

__destruct() : mixed

Closes the stream when the destructed.

Returns

mixed —

close()

close() : void

Closes the stream and any underlying resources.

detach()

detach() : resource|null

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Returns

resource|null —

Underlying PHP stream, if any