ChainedBlockStream
Table of Contents
- $context : mixed
- $data : string
- The binary data of the file.
- $ole : null|OLE
- The OLE container of the file that is being read.
- $params : array<string|int, mixed>
- Parameters specified by fopen().
- $pos : int
- The file pointer.
- stream_close() : void
- Implements support for fclose().
- stream_eof() : bool
- Implements support for feof().
- stream_open() : bool
- Implements support for fopen().
- stream_read() : false|string
- Implements support for fread(), fgets() etc.
- stream_seek() : bool
- Implements support for fseek().
- stream_stat() : array<string|int, mixed>
- Implements support for fstat(). Currently the only supported field is "size".
- stream_tell() : int
- Returns the position of the file pointer, i.e. its offset into the file stream. Implements support for ftell().
Properties
$context
public
mixed
$context
$data
The binary data of the file.
public
string
$data
$ole
The OLE container of the file that is being read.
public
null|OLE
$ole
$params
Parameters specified by fopen().
public
array<string|int, mixed>
$params
$pos
The file pointer.
public
int
$pos
Methods
stream_close()
Implements support for fclose().
public
stream_close() : void
Return values
void —stream_eof()
Implements support for feof().
public
stream_eof() : bool
Return values
bool —TRUE if the file pointer is at EOF; otherwise FALSE
stream_open()
Implements support for fopen().
public
stream_open(string $path, string $mode, int $options, string &$openedPath) : bool
For creating streams using this wrapper, use OLE_PPS_File::getStream().
Parameters
- $path : string
-
resource name including scheme, e.g. ole-chainedblockstream://oleInstanceId=1
- $mode : string
-
only "r" is supported
- $options : int
-
mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH
- $openedPath : string
-
absolute path of the opened stream (out parameter)
Return values
bool —true on success
stream_read()
Implements support for fread(), fgets() etc.
public
stream_read(int $count) : false|string
Parameters
- $count : int
-
maximum number of bytes to read
Return values
false|string —stream_seek()
Implements support for fseek().
public
stream_seek(int $offset, int $whence) : bool
Parameters
- $offset : int
-
byte offset
- $whence : int
-
SEEK_SET, SEEK_CUR or SEEK_END
Return values
bool —stream_stat()
Implements support for fstat(). Currently the only supported field is "size".
public
stream_stat() : array<string|int, mixed>
Return values
array<string|int, mixed> —stream_tell()
Returns the position of the file pointer, i.e. its offset into the file stream. Implements support for ftell().
public
stream_tell() : int