1. class
  2. http
  3. \
  4. Encoding
  5. \
  6. Stream
  7. \
  8. Inflate

Inflate

class Inflate extends Stream (View source)

A inflate stream supporting deflate, zlib and gzip encodings.

Constants

FLUSH_NONE

Do no intermittent flushes.
FLUSH_SYNC

Flush at appropriate transfer points.
FLUSH_FULL

Flush at each IO operation.

Methods

__construct(int $flags = 0)

Base constructor for encoding stream implementations.

from  Stream
bool
done()

Check whether the encoding stream is already done.

from  Stream
string
finish()

Finish and reset the encoding stream.

from  Stream
string
flush()

Flush the encoding stream.

from  Stream
string
update(string $data)

Update the encoding stream with more input.

from  Stream
string
decode(string $data)

Decode deflate/zlib/gzip encoded data.

Details

in Stream at line 2675
__construct(int $flags = 0)

Base constructor for encoding stream implementations.

Parameters

int $flags

See http\Encoding\Stream and implementation specific constants.

Exceptions

InvalidArgumentException
RuntimeException

in Stream at line 2682
bool done()

Check whether the encoding stream is already done.

Return Value

bool

whether the encoding stream is completed.

in Stream at line 2690
string finish()

Finish and reset the encoding stream.

Returns any pending data.

Return Value

string

any pending data.

in Stream at line 2698
string flush()

Flush the encoding stream.

Returns any pending data.

Return Value

string

any pending data.

in Stream at line 2706
string update(string $data)

Update the encoding stream with more input.

Parameters

string $data

The data to pass through the stream.

Return Value

string

processed data.

at line 2903
string decode(string $data)

Decode deflate/zlib/gzip encoded data.

Parameters

string $data

The data to uncompress.

Return Value

string

the uncompressed data.