Class: OLE_ChainedBlockStream

Source Location: /main/inc/lib/pear/OLE/ChainedBlockStream.php

Class Overview

PEAR
   |
   --OLE_ChainedBlockStream

Stream wrapper for reading data stored in an OLE file. Implements methods for PHP's stream_wrapper_register(). For creating streams using this wrapper, use OLE_PPS_File::getStream().

Author(s):

Christian Schmidt <schmidt@php.net>

Version:

Release: @package_version@

Copyright:

1997-2006 The PHP Group

Variables

Methods

Inherited Variables

Class: PEAR

PEAR::$_debug
PEAR::$_default_error_handler
PEAR::$_default_error_mode
PEAR::$_default_error_options
PEAR::$_error_class
PEAR::$_expected_errors

Inherited Methods

Class: PEAR

PEAR::PEAR(): Constructor. Registers this object in $_PEAR_destructor_object_list for destructor emulation if a destructor object exists.
PEAR::delExpect(): This method deletes all occurences of the specified element from the expected error codes stack.
PEAR::expectError(): This method is used to tell which errors you expect to get.
PEAR::getStaticProperty(): If you have a class that's mostly/entirely static, and you need static
PEAR::isError(): Tell whether a value is a PEAR error.
PEAR::loadExtension(): OS independant PHP extension load. Remember to take care on the correct extension name for case sensitive OSes.
PEAR::popErrorHandling(): Pop the last error handler used
PEAR::popExpect(): This method pops one element off the expected error codes stack.
PEAR::pushErrorHandling(): Push a new error handler on top of the error handler options stack. With this you can easily override the actual error handler for some code and restore it later with popErrorHandling.
PEAR::raiseError(): This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. If the $mode and $options parameters are not specified, the object's defaults are used.
PEAR::registerShutdownFunc(): Use this function to register a shutdown method for static classes.
PEAR::setErrorHandling(): Sets how errors generated by this object should be handled.
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError(): Simpler form of raiseError with fewer options. In most cases message, code and userinfo are enough.
PEAR::_checkDelExpect(): This method checks unsets an error code if available
PEAR::_PEAR(): Destructor (the emulated type of...). Does nothing right now, but is included for forward compatibility, so subclass destructors should always call it.

Class Details

[line 41]
Stream wrapper for reading data stored in an OLE file. Implements methods for PHP's stream_wrapper_register(). For creating streams using this wrapper, use OLE_PPS_File::getStream().

Tags:

author:	Christian Schmidt <schmidt@php.net>
version:	Release: @package_version@
copyright:	1997-2006 The PHP Group
link:	http://pear.php.net/package/OLE
since:	Class available since Release 0.6.0
license:	PHP License 3.0

[ Top ]

Class Variables

$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.

Tags:

var:

byte offset

Type:

int

[ Top ]

Class Methods

method stream_close [line 137]

string stream_close(
)

Implements support for fclose().

[ Top ]

method stream_eof [line 162]

bool stream_eof(
)

Implements support for feof().

Tags:

return:

TRUE if the file pointer is at EOF; otherwise FALSE

[ Top ]

method 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().

Tags:

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 ]

method 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 ]

method 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 ]

method stream_stat [line 209]

array stream_stat(
)

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

[ Top ]

method 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 ]

Documentation generated on Thu, 12 Jun 2008 13:03:03 -0500 by phpDocumentor 1.4.1