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

Class: OLE_PPS

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

Class Overview

PEAR
   |
   --OLE_PPS

Class for creating PPS's for OLE containers


Author(s):

Version:

  • Release: 1.4.11

Copyright:

  • 1997-2006 The PHP Group

Variables

Methods


Child classes:

OLE_PPS_File
Class for creating File PPS's for OLE containers
OLE_PPS_Root
Class for creating Root PPS's for OLE containers

Inherited Variables

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 33]
Class for creating 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

$children = array()

[line 105]

Array of child PPS's (only used by Root and Dir PPS's)


Type:   array


[ Top ]

$DirPps =

[line 69]

The index of it's first child if this is a Dir or Root PPS


Type:   integer


[ Top ]

$Name =

[line 45]

The PPS name (in Unicode)


Type:   string


[ Top ]

$NextPps =

[line 63]

The index of the next PPS


Type:   integer


[ Top ]

$No =

[line 39]

The PPS index


Type:   integer


[ Top ]

$ole =

[line 111]

Pointer to OLE container


Type:   OLE


[ Top ]

$PrevPps =

[line 57]

The index of the previous PPS


Type:   integer


[ Top ]

$Size =

[line 93]

The size of the PPS's data (in bytes)


Type:   integer


[ Top ]

$Time1st =

[line 75]

A timestamp


Type:   integer


[ Top ]

$Time2nd =

[line 81]

A timestamp


Type:   integer


[ Top ]

$Type =

[line 51]

The PPS type. Dir, Root or File


Type:   integer


[ Top ]

$_data =

[line 99]

The PPS's data (only used if it's not using a temporary file)


Type:   string


[ Top ]

$_StartBlock =

[line 87]

Starting block (small or big) for this PPS's data inside the container


Type:   integer


[ Top ]



Class Methods


constructor OLE_PPS [line 128]

OLE_PPS OLE_PPS( integer $No, string $name, integer $type, integer $prev, integer $next, integer $dir, integer $time_1st, integer $time_2nd, string $data, array $children)

The constructor



Tags:

access:  public


Parameters:

integer   $No   The PPS index
string   $name   The PPS name
integer   $type   The PPS type. Dir, Root or File
integer   $prev   The index of the previous PPS
integer   $next   The index of the next PPS
integer   $dir   The index of it's first child if this is a Dir or Root PPS
integer   $time_1st   A timestamp
integer   $time_2nd   A timestamp
string   $data   The (usually binary) source data of the PPS
array   $children   Array containing children PPS for this PPS

[ Top ]

method _DataLen [line 153]

integer _DataLen( )

Returns the amount of data saved for this PPS



Tags:

return:  The amount of data (in bytes)
access:  private


[ Top ]

method _getPpsWk [line 173]

string _getPpsWk( )

Returns a string with the PPS's WK (What is a WK?)



Tags:

return:  The binary string
access:  private


[ Top ]

method _savePpsSetPnt [line 208]

integer _savePpsSetPnt( array &$pps_array)

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.



Tags:

return:  The index for this PPS
access:  private


Parameters:

array   &$pps_array   Reference to the array of PPS's for the whole OLE container

[ Top ]


Documentation generated on Thu, 12 Jun 2008 09:26:12 -0500 by phpDocumentor 1.4.1