\ZipStreamDeflateStream

Describes a data stream.

Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.

Summary

Methods
Properties
Constants
__construct()
close()
detach()
__toString()
seek()
isSeekable()
getMetadata()
getSize()
tell()
eof()
rewind()
write()
isWritable()
read()
isReadable()
getContents()
removeDeflateFilter()
addDeflateFilter()
No public properties found
No constants found
No protected methods found
$stream
$filter
$options
N/A
No private methods found
No private properties found
N/A

Properties

$stream

$stream

$filter

$filter

$options

$options : \ZipStream\Option\File

Type

File

Methods

__construct()

__construct(mixed  $stream) : mixed

Parameters

mixed $stream

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

__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 —

seek()

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

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.

isSeekable()

isSeekable() : bool

Returns whether or not the stream is seekable.

Returns

bool —

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.

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 —

rewind()

rewind() : void

Rewind stream

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.

isWritable()

isWritable() : bool

Returns whether or not the stream is writable.

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.

isReadable()

isReadable() : bool

Returns whether or not the stream is readable.

Returns

bool —

getContents()

getContents() : string

Returns the remaining contents in a string

Throws

\RuntimeException

if unable to read or an error occurs while reading.

Returns

string —

removeDeflateFilter()

removeDeflateFilter() : void

Remove the deflate filter

addDeflateFilter()

addDeflateFilter(\ZipStream\Option\File  $options) : void

Add a deflate filter

Parameters

\ZipStream\Option\File $options