Docs For Class OLE_ChainedBlockStream

$data =

[line 59]

The binary data of the file.

Type:

string

[ Top ]

$ole =

[line 47]

The OLE container of the file that is being read.

Type:

OLE

[ Top ]

$params =

[line 53]

Parameters specified by fopen().

Type:

array

[ Top ]

$pos =

[line 65]

The file pointer.

Var: byte offset

Type:

int

[ Top ]

stream_close [line 137]

string stream_close(
)

Implements support for fclose().

[ Top ]

stream_eof [line 162]

bool stream_eof(
)

Implements support for feof().

Return: TRUE if the file pointer is at EOF; otherwise FALSE

[ Top ]

stream_open [line 77]

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

Implements support for fopen().

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

Return: true on success

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)

[ Top ]

stream_read [line 148]

string stream_read(
int
$count)

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

Parameters:

int $count — maximum number of bytes to read

[ Top ]

stream_seek [line 190]

bool stream_seek(
int
$offset, int
$whence)

Implements support for fseek().

Parameters:

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

[ Top ]

stream_stat [line 209]

array stream_stat(
)

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

[ Top ]

stream_tell [line 179]

int stream_tell(
)

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

[ Top ]

Class: OLE_ChainedBlockStream

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$data =

$ole =

$params =

$pos =

Method Detail

stream_close [line 137]

stream_eof [line 162]

stream_open [line 77]

Parameters:

stream_read [line 148]

Parameters:

stream_seek [line 190]

Parameters:

stream_stat [line 209]

stream_tell [line 179]