Autene
\

\PHPExcel_Shared_OLE_ChainedBlockStream

PHPExcel_Shared_OLE_ChainedBlockStream

Stream wrapper for reading data stored in an OLE file. Implements methods for PHP's stream_wrapper_register(). For creating streams using this wrapper, use PHPExcel_Shared_OLE_PPS_File::getStream().

Summary

Methods
Properties
Constants
stream_open()
stream_close()
stream_read()
stream_eof()
stream_tell()
stream_seek()
stream_stat()
$ole
$params
$data
$pos
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$ole

$ole : \OLE

The OLE container of the file that is being read.

Type

\OLE

$params

$params : array

Parameters specified by fopen().

Type

array

$data

$data : string

The binary data of the file.

Type

string

$pos

$pos : integer

The file pointer.

Type

integer — byte offset

Methods

stream_open()

stream_open(string  $path, string  $mode, integer  $options,   $openedPath) : boolean

Implements support for fopen().

For creating streams using this wrapper, use OLE_PPS_File::getStream().

Parameters

string $path

resource name including scheme, e.g. ole-chainedblockstream://oleInstanceId=1
string $mode

only "r" is supported
integer $options

mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH
$openedPath

Returns

boolean —

true on success

stream_close()

stream_close()

Implements support for fclose().

stream_read()

stream_read(integer  $count) : string

Implements support for fread(), fgets() etc.

Parameters

integer $count

maximum number of bytes to read

Returns

string

stream_eof()

stream_eof() : boolean

Implements support for feof().

Returns

boolean —

TRUE if the file pointer is at EOF; otherwise FALSE

stream_tell()

stream_tell() : integer

Returns the position of the file pointer, i.e. its offset into the file stream. Implements support for ftell().

Returns

integer

stream_seek()

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

Implements support for fseek().

Parameters

integer $offset

byte offset
integer $whence

SEEK_SET, SEEK_CUR or SEEK_END

Returns

boolean

stream_stat()

stream_stat() : array

Implements support for fstat(). Currently the only supported field is "size".

Returns

array