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

Stream

abstract class Stream (View source)

Base class for encoding stream implementations.

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.

bool
done()

Check whether the encoding stream is already done.

string
finish()

Finish and reset the encoding stream.

string
flush()

Flush the encoding stream.

string
update(string $data)

Update the encoding stream with more input.

Details

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

at line 2682
bool done()

Check whether the encoding stream is already done.

Return Value

bool

whether the encoding stream is completed.

at line 2690
string finish()

Finish and reset the encoding stream.

Returns any pending data.

Return Value

string

any pending data.

at line 2698
string flush()

Flush the encoding stream.

Returns any pending data.

Return Value

string

any pending data.

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.