OLE
[ class tree: OLE ] [ index: OLE ] [ all elements ]

Class: OLE_PPS_File

Source Location: /main/inc/lib/pear/OLE/PPS/File.php

Class Overview

PEAR
   |
   --OLE_PPS
      |
      --OLE_PPS_File

Class for creating File PPS's for OLE containers


Author(s):

Version:

  • Release: 1.4.11

Copyright:

  • 1997-2006 The PHP Group

Variables

Methods


Inherited Variables

Inherited Methods

Class: OLE_PPS

OLE_PPS::OLE_PPS()
The constructor
OLE_PPS::_DataLen()
Returns the amount of data saved for this PPS
OLE_PPS::_getPpsWk()
Returns a string with the PPS's WK (What is a WK?)
OLE_PPS::_savePpsSetPnt()
Updates index and pointers to previous, next and children PPS's for this PPS. I don't think it'll work with Dir PPS's.

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 32]
Class for creating File PPS's for OLE containers



Tags:

author:  Xavier Noguer <xnoguer@php.net>
version:  Release: 1.4.11
copyright:  1997-2006 The PHP Group


[ Top ]


Class Variables

$_tmp_dir =

[line 38]

The temporary dir for storing the OLE file


Type:   string


[ Top ]



Class Methods


constructor OLE_PPS_File [line 47]

OLE_PPS_File OLE_PPS_File( string $name)

The constructor



Tags:

see:  OLE::Asc2Ucs()
access:  public


Parameters:

string   $name   The name of the file (in Unicode)

[ Top ]

method append [line 106]

void append( string $data)

Append data to PPS



Tags:

access:  public


Parameters:

string   $data   The data to append

[ Top ]

method getStream [line 119]

resource getStream( )

Returns a stream for reading this file using fread() etc.



Tags:

return:  a read-only stream


[ Top ]

method init [line 85]

mixed init( )

Initialization method. Has to be called right after OLE_PPS_File().



Tags:

return:  true on success. PEAR_Error on failure
access:  public


[ Top ]

method setTempDir [line 70]

true setTempDir( string $dir)

Sets the temp dir used for storing the OLE file



Tags:

return:  if given dir is valid, false otherwise
access:  public


Parameters:

string   $dir   The dir to be used as temp dir

[ Top ]


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