class PHPExcel_Shared_OLE_ChainedBlockStream

PHPExcelSharedOLE_ChainedBlockStream

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Properties

OLE $ole The OLE container of the file that is being read.
array $params Parameters specified by fopen().
string $data The binary data of the file.
int $pos The file pointer.

Methods

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

Implements support for fopen().

stream_close()

Implements support for fclose().

string
stream_read(int $count)

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

bool
stream_eof()

Implements support for feof().

int
stream_tell()

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

bool
stream_seek(int $offset, int $whence)

Implements support for fseek().

array
stream_stat()

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

Details

at line 74
bool stream_open(string $path, string $mode, int $options, string $openedPath)

Implements support for fopen().

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

Parameters

string $path resource name including scheme, e.g. ole-chainedblockstream://oleInstanceId=1
string $mode only "r" is supported
int $options mask of STREAMREPORTERRORS and STREAMUSEPATH
string $openedPath &$openedPath absolute path of the opened stream (out parameter)

Return Value

bool true on success

at line 128
stream_close()

Implements support for fclose().

at line 140
string stream_read(int $count)

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

Parameters

int $count maximum number of bytes to read

Return Value

string

at line 155
bool stream_eof()

Implements support for feof().

Return Value

bool TRUE if the file pointer is at EOF; otherwise FALSE

at line 166
int stream_tell()

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

Return Value

int

at line 178
bool stream_seek(int $offset, int $whence)

Implements support for fseek().

Parameters

int $offset byte offset
int $whence SEEKSET, SEEKCUR or SEEK_END

Return Value

bool

at line 197
array stream_stat()

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

Return Value

array