PHPExcel_Shared_OLE_ChainedBlockStream Class Reference

Collaboration diagram for PHPExcel_Shared_OLE_ChainedBlockStream:

Public Member Functions
	stream_open ($path, $mode, $options, &$openedPath)
	Implements support for fopen(). More...
	stream_close ()
	Implements support for fclose(). More...
	stream_read ($count)
	Implements support for fread(), fgets() etc. More...
	stream_eof ()
	Implements support for feof(). More...
	stream_tell ()
	Returns the position of the file pointer, i.e. More...
	stream_seek ($offset, $whence)
	Implements support for fseek(). More...
	stream_stat ()
	Implements support for fstat(). More...

Data Fields
	$ole
	$params
	$data
	$pos

Detailed Description

Definition at line 38 of file ChainedBlockStream.php.

Member Function Documentation

stream_close()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_close

(

)

Implements support for fclose().

Definition at line 135 of file ChainedBlockStream.php.

References $GLOBALS.

        {
                $this->ole = null;
                unset($GLOBALS['_OLE_INSTANCES']);
        }

stream_eof()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_eof

(

)

Implements support for feof().

Returns

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

Definition at line 162 of file ChainedBlockStream.php.

References data.

Referenced by stream_read().

        {
                return $this->pos >= strlen($this->data);
        }

Here is the caller graph for this function:

stream_open()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_open	(		$path,
			$mode,
			$options,
		&	$openedPath
	)

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

Definition at line 75 of file ChainedBlockStream.php.

References $GLOBALS, $options, $path, $pos, and data.

        {
                if ($mode != 'r') {
                        if ($options & STREAM_REPORT_ERRORS) {
                                trigger_error('Only reading is supported', E_USER_WARNING);
                        }
                        return false;
                }

                // 25 is length of "ole-chainedblockstream://"
                parse_str(substr($path, 25), $this->params);
                if (!isset($this->params['oleInstanceId'],
                                   $this->params['blockId'],
                                   $GLOBALS['_OLE_INSTANCES'][$this->params['oleInstanceId']])) {

                        if ($options & STREAM_REPORT_ERRORS) {
                                trigger_error('OLE stream not found', E_USER_WARNING);
                        }
                        return false;
                }
                $this->ole = $GLOBALS['_OLE_INSTANCES'][$this->params['oleInstanceId']];

                $blockId = $this->params['blockId'];
                $this->data = '';
                if (isset($this->params['size']) &&
                        $this->params['size'] < $this->ole->bigBlockThreshold &&
                        $blockId != $this->ole->root->_StartBlock) {

                        // Block id refers to small blocks
                        $rootPos = $this->ole->_getBlockOffset($this->ole->root->_StartBlock);
                        while ($blockId != -2) {
                                $pos = $rootPos + $blockId * $this->ole->bigBlockSize;
                                $blockId = $this->ole->sbat[$blockId];
                                fseek($this->ole->_file_handle, $pos);
                                $this->data .= fread($this->ole->_file_handle, $this->ole->bigBlockSize);
                        }
                } else {
                        // Block id refers to big blocks
                        while ($blockId != -2) {
                                $pos = $this->ole->_getBlockOffset($blockId);
                                fseek($this->ole->_file_handle, $pos);
                                $this->data .= fread($this->ole->_file_handle, $this->ole->bigBlockSize);
                                $blockId = $this->ole->bbat[$blockId];
                        }
                }
                if (isset($this->params['size'])) {
                        $this->data = substr($this->data, 0, $this->params['size']);
                }

                if ($options & STREAM_USE_PATH) {
                        $openedPath = $path;
                }

                return true;
        }

stream_read()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_read

(

$count

)

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

Parameters

int

$count

maximum number of bytes to read

Returns

string

Definition at line 147 of file ChainedBlockStream.php.

References data, and stream_eof().

        {
                if ($this->stream_eof()) {
                        return false;
                }
                $s = substr($this->data, $this->pos, $count);
                $this->pos += $count;
                return $s;
        }

Here is the call graph for this function:

stream_seek()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_seek	(		$offset,
			$whence
	)

Implements support for fseek().

Parameters

int	$offset	byte offset
int	$whence	SEEK_SET, SEEK_CUR or SEEK_END

Returns

bool

Definition at line 185 of file ChainedBlockStream.php.

References data.

        {
                if ($whence == SEEK_SET && $offset >= 0) {
                        $this->pos = $offset;
                } elseif ($whence == SEEK_CUR && -$offset <= $this->pos) {
                        $this->pos += $offset;
                } elseif ($whence == SEEK_END && -$offset <= sizeof($this->data)) {
                        $this->pos = strlen($this->data) + $offset;
                } else {
                        return false;
                }
                return true;
        }

stream_stat()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_stat

(

)

Implements support for fstat().

Currently the only supported field is "size".

Returns

array

Definition at line 204 of file ChainedBlockStream.php.

References array, and data.

        {
                return array(
                        'size' => strlen($this->data),
                        );
        }

stream_tell()

PHPExcel_Shared_OLE_ChainedBlockStream::stream_tell

(

)

Returns the position of the file pointer, i.e.

its offset into the file stream. Implements support for ftell().

Returns

int

Definition at line 173 of file ChainedBlockStream.php.

References $pos.

        {
                return $this->pos;
        }

Field Documentation

$data

PHPExcel_Shared_OLE_ChainedBlockStream::$data

Definition at line 56 of file ChainedBlockStream.php.

$ole

PHPExcel_Shared_OLE_ChainedBlockStream::$ole

Definition at line 44 of file ChainedBlockStream.php.

$params

PHPExcel_Shared_OLE_ChainedBlockStream::$params

Definition at line 50 of file ChainedBlockStream.php.

$pos

PHPExcel_Shared_OLE_ChainedBlockStream::$pos

Definition at line 62 of file ChainedBlockStream.php.

Referenced by stream_open(), and stream_tell().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/OLE/ChainedBlockStream.php