API Documentation
\

\Horde_Stream_Wrapper_Combine

A stream wrapper that will combine multiple strings/streams into a single stream.

Summary

Methods
Properties
Constants
getStream()
stream_open()
stream_read()
stream_write()
stream_tell()
stream_eof()
stream_stat()
stream_seek()
$context
WRAPPER_NAME
No protected methods found
$_data
$_length
$_position
$_datapos
$_ateof
N/A
No private methods found
$_id
N/A

Constants

WRAPPER_NAME

WRAPPER_NAME

Properties

$context

$context : resource

Context.

Type

resource

$_data

$_data : array

Array that holds the various streams.

Type

array

$_length

$_length : integer

The combined length of the stream.

Type

integer

$_position

$_position : integer

The current position in the string.

Type

integer

$_datapos

$_datapos : integer

The current position in the data array.

Type

integer

$_ateof

$_ateof : boolean

Have we reached EOF?

Type

boolean

$_id

$_id : integer

Unique ID tracker for the streams.

Type

integer

Methods

getStream()

getStream(array  $data) : resource

Create a stream from multiple data sources.

Parameters

array $data

An array of strings and/or streams to combine into a single stream.

Returns

resource —

A PHP stream.

stream_open()

stream_open(string  $path, string  $mode, integer  $options,   $opened_path)

Parameters

string $path
string $mode
integer $options
$opened_path

Throws

\Exception

stream_read()

stream_read(integer  $count) : mixed

Parameters

integer $count

Returns

mixed

stream_write()

stream_write(string  $data) : integer

Parameters

string $data

Returns

integer

stream_tell()

stream_tell() : integer

Returns

integer

stream_eof()

stream_eof() : boolean

Returns

boolean

stream_stat()

stream_stat() : array

Returns

array

stream_seek()

stream_seek(integer  $offset, integer  $whence) : boolean

Parameters

integer $offset
integer $whence

SEEK_SET, SEEK_CUR, or SEEK_END

Returns

boolean