Class OLE_PPS

Description

Class for creating PPS's for OLE containers

Located in /libraries/pear/OLE/PPS.php (line 33)

PEAR
   |
   --OLE_PPS
Direct descendents
Class Description
 class OLE_PPS_File Class for creating File PPS's for OLE containers
 class OLE_PPS_Root Class for creating Root PPS's for OLE containers
Variable Summary
 array $children
 integer $DirPps
 string $Name
 integer $NextPps
 integer $No
 integer $PrevPps
 integer $Size
 integer $Time1st
 integer $Time2nd
 integer $Type
 string $_data
 integer $_StartBlock
Method Summary
 OLE_PPS OLE_PPS (integer $No, string $name, integer $type, integer $prev, integer $next, integer $dir, integer $time_1st, integer $time_2nd, mixed $data, array $children)
 integer _DataLen ()
 string _getPpsWk ()
 integer _savePpsSetPnt (array &$pps_array)
Variables
array $children = array() (line 105)

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

integer $DirPps (line 69)

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

string $Name (line 45)

The PPS name (in Unicode)

integer $NextPps (line 63)

The index of the next PPS

integer $No (line 39)

The PPS index

integer $PrevPps (line 57)

The index of the previous PPS

integer $Size (line 93)

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

integer $Time1st (line 75)

A timestamp

integer $Time2nd (line 81)

A timestamp

integer $Type (line 51)

The PPS type. Dir, Root or File

string $_data (line 99)

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

integer $_StartBlock (line 87)

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

Methods
Constructor OLE_PPS (line 121)

The constructor

  • access: public
OLE_PPS OLE_PPS (integer $No, string $name, integer $type, integer $prev, integer $next, integer $dir, integer $time_1st, integer $time_2nd, mixed $data, array $children)
  • integer $No: The PPS index
  • string $name: The PPS name (in Unicode)
  • 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
  • array $children: Array containing children PPS for this PPS
_DataLen (line 147)

Returns the amount of data saved for this PPS

  • return: The amount of data (in bytes)
  • access: private
integer _DataLen ()
_getPpsWk (line 169)

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

  • return: The binary string
  • access: private
string _getPpsWk ()
_savePpsSetPnt (line 204)

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.

  • return: The index for this PPS
  • access: private
integer _savePpsSetPnt (array &$pps_array)
  • array &$pps_array: Reference to the array of PPS's for the whole OLE container

Documentation generated on Fri, 11 Feb 2005 18:13:55 +0000 by phpDocumentor 1.3.0RC3