class PHPExcel_Shared_OLE_PPS_Root extends PHPExcel_Shared_OLE_PPS

Class for creating Root PPS's for OLE containers

Properties

integer $No The PPS index from PHPExcel_Shared_OLE_PPS
string $Name The PPS name (in Unicode) from PHPExcel_Shared_OLE_PPS
integer $Type The PPS type. Dir, Root or File from PHPExcel_Shared_OLE_PPS
integer $PrevPps The index of the previous PPS from PHPExcel_Shared_OLE_PPS
integer $NextPps The index of the next PPS from PHPExcel_Shared_OLE_PPS
integer $DirPps The index of it's first child if this is a Dir or Root PPS from PHPExcel_Shared_OLE_PPS
integer $Time1st A timestamp from PHPExcel_Shared_OLE_PPS
integer $Time2nd A timestamp from PHPExcel_Shared_OLE_PPS
integer $_StartBlock Starting block (small or big) for this PPS's data inside the container from PHPExcel_Shared_OLE_PPS
integer $Size The size of the PPS's data (in bytes) from PHPExcel_Shared_OLE_PPS
string $_data The PPS's data (only used if it's not using a temporary file) from PHPExcel_Shared_OLE_PPS
array $children Array of child PPS's (only used by Root and Dir PPS's) from PHPExcel_Shared_OLE_PPS
OLE $ole Pointer to OLE container from PHPExcel_Shared_OLE_PPS

Methods

__construct(integer $time_1st, integer $time_2nd, $raChild)

No description

integer
_DataLen()

Returns the amount of data saved for this PPS

string
_getPpsWk()

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

static integer
_savePpsSetPnt($raList, $to_save, $depth)

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.

mixed
save(string|resource $filename)

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

array
_calcSize(array $raList)

Calculate some numbers

_saveHeader(integer $iSBDcnt, integer $iBBcnt, integer $iPPScnt)

Save OLE header

_saveBigData(integer $iStBlk, array $raList)

Saving big data (PPS's with data bigger than PHPExcelSharedOLE::OLEDATASIZE_SMALL)

_makeSmallData(array $raList)

get small data (PPS's with data smaller than PHPExcelSharedOLE::OLEDATASIZE_SMALL)

_savePps(array $raList)

Saves all the PPS's WKs

_saveBbd(integer $iSbdSize, integer $iBsize, integer $iPpsCnt)

Saving Big Block Depot

Details

at line 52
__construct(integer $time_1st, integer $time_2nd, $raChild)

Parameters

integer $time_1st A timestamp
integer $time_2nd A timestamp
$raChild

integer _DataLen()

Returns the amount of data saved for this PPS

Return Value

integer The amount of data (in bytes)

string _getPpsWk()

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

Return Value

string The binary string

static integer _savePpsSetPnt($raList, $to_save, $depth)

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.

Parameters

$raList
$to_save
$depth

Return Value

integer The index for this PPS

at line 70
mixed save(string|resource $filename)

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. If a resource pointer to a stream created by fopen() is passed it will be used, but you have to close such stream by yourself.

Parameters

string|resource $filename The name of the file or stream where to save the OLE container.

Return Value

mixed true on success

at line 131
array _calcSize(array $raList)

Calculate some numbers

Parameters

array $raList Reference to an array of PPS's

Return Value

array The array of numbers

at line 184
_saveHeader(integer $iSBDcnt, integer $iBBcnt, integer $iPPScnt)

Save OLE header

Parameters

integer $iSBDcnt
integer $iBBcnt
integer $iPPScnt

at line 264
_saveBigData(integer $iStBlk, array $raList)

Saving big data (PPS's with data bigger than PHPExcelSharedOLE::OLEDATASIZE_SMALL)

Parameters

integer $iStBlk
array $raList &$raList Reference to array of PPS's

at line 311
_makeSmallData(array $raList)

get small data (PPS's with data smaller than PHPExcelSharedOLE::OLEDATASIZE_SMALL)

Parameters

array $raList &$raList Reference to array of PPS's

at line 368
_savePps(array $raList)

Saves all the PPS's WKs

Parameters

array $raList Reference to an array with all PPS's

at line 391
_saveBbd(integer $iSbdSize, integer $iBsize, integer $iPpsCnt)

Saving Big Block Depot

Parameters

integer $iSbdSize
integer $iBsize
integer $iPpsCnt