\PhpOffice\PhpSpreadsheet\Shared\OLEChainedBlockStream

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 : \PhpOffice\PhpSpreadsheet\Shared\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 : int

The file pointer.

Type

int — byte offset

Methods

stream_open()

stream_open(string  $path, string  $mode, int  $options, string  $openedPath) : bool

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

int $options

mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH

string $openedPath

absolute path of the opened stream (out parameter)

Returns

bool —

true on success

stream_close()

stream_close() : void

Implements support for fclose().

stream_read()

stream_read(int  $count) : string

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

Parameters

int $count

maximum number of bytes to read

Returns

string —

stream_eof()

stream_eof() : bool

Implements support for feof().

Returns

bool —

TRUE if the file pointer is at EOF; otherwise FALSE

stream_tell()

stream_tell() : int

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

Returns

int —

stream_seek()

stream_seek(int  $offset, int  $whence) : bool

Implements support for fseek().

Parameters

int $offset

byte offset

int $whence

SEEK_SET, SEEK_CUR or SEEK_END

Returns

bool —

stream_stat()

stream_stat() : array

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

Returns

array —