Class OLE_PPS_Root

Description

Class for creating Root PPS's for OLE containers

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

PEAR
   |
   --OLE_PPS
      |
      --OLE_PPS_Root
Variable Summary
 string $_tmp_dir
Method Summary
 OLE_PPS_Root OLE_PPS_Root (integer $time_1st, integer $time_2nd, mixed $raChild)
 mixed save (string $filename)
 true setTempDir (string $dir)
 integer _adjust2 (integer $i2)
 array _calcSize (array &$raList)
 void _makeSmallData (array &$raList)
 void _saveBbd (integer $iSbdSize, integer $iBsize, integer $iPpsCnt)
 void _saveBigData (integer $iStBlk, array &$raList)
 void _saveHeader (integer $iSBDcnt, integer $iBBcnt, integer $iPPScnt)
 void _savePps (array &$raList)
Variables
Methods
Constructor OLE_PPS_Root (line 47)

Constructor

  • access: public
OLE_PPS_Root OLE_PPS_Root (integer $time_1st, integer $time_2nd, mixed $raChild)
  • integer $time_1st: A timestamp
  • integer $time_2nd: A timestamp
save (line 88)

Method for saving the whole OLE container (including files).

In fact, if called with an empty argument (or '-'), it saves to a temporary file and then outputs it's contents to stdout.

  • return: true on success, PEAR_Error on failure
  • access: public
mixed save (string $filename)
  • string $filename: The name of the file where to save the OLE container
setTempDir (line 70)

Sets the temp dir used for storing the OLE file

  • return: if given dir is valid, false otherwise
  • access: public
true setTempDir (string $dir)
  • string $dir: The dir to be used as temp dir
_adjust2 (line 190)

Helper function for caculating a magic value for block sizes

integer _adjust2 (integer $i2)
  • integer $i2: The argument
_calcSize (line 151)

Calculate some numbers

  • return: The array of numbers
  • access: private
array _calcSize (array &$raList)
  • array $raList: Reference to an array of PPS's
_makeSmallData (line 344)

get small data (PPS's with data smaller than OLE_DATA_SIZE_SMALL)

  • access: private
void _makeSmallData (array &$raList)
  • array &$raList: Reference to array of PPS's
_saveBbd (line 432)

Saving Big Block Depot

  • access: private
void _saveBbd (integer $iSbdSize, integer $iBsize, integer $iPpsCnt)
  • integer $iSbdSize
  • integer $iBsize
  • integer $iPpsCnt
_saveBigData (line 287)

Saving big data (PPS's with data bigger than OLE_DATA_SIZE_SMALL)

  • access: private
void _saveBigData (integer $iStBlk, array &$raList)
  • integer $iStBlk
  • array &$raList: Reference to array of PPS's
_saveHeader (line 204)

Save OLE header

  • access: private
void _saveHeader (integer $iSBDcnt, integer $iBBcnt, integer $iPPScnt)
  • integer $iSBDcnt
  • integer $iBBcnt
  • integer $iPPScnt
_savePps (line 407)

Saves all the PPS's WKs

  • access: private
void _savePps (array &$raList)
  • array $raList: Reference to an array with all PPS's

Inherited Methods

Inherited From OLE_PPS

 OLE_PPS::OLE_PPS()
 OLE_PPS::_DataLen()
 OLE_PPS::_getPpsWk()
 OLE_PPS::_savePpsSetPnt()

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