\PHPExcel_Shared_OLE_PPS_Root

Class for creating Root PPS's for OLE containers

Summary

Methods
Properties
Constants
__construct()
_DataLen()
_getPpsWk()
_savePpsSetPnt()
save()
_calcSize()
_saveHeader()
_saveBigData()
_makeSmallData()
_savePps()
_saveBbd()
$No
$Name
$Type
$PrevPps
$NextPps
$DirPps
$Time1st
$Time2nd
$_StartBlock
$Size
$_data
$children
$ole
No constants found
No protected methods found
$_tmp_dir
N/A
_adjust2()
No private properties found
N/A

Properties

$No

$No : int

The PPS index

Type

int

$Name

$Name : string

The PPS name (in Unicode)

Type

string

$Type

$Type : int

The PPS type. Dir, Root or File

Type

int

$PrevPps

$PrevPps : int

The index of the previous PPS

Type

int

$NextPps

$NextPps : int

The index of the next PPS

Type

int

$DirPps

$DirPps : int

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

Type

int

$Time1st

$Time1st : int

A timestamp

Type

int

$Time2nd

$Time2nd : int

A timestamp

Type

int

$_StartBlock

$_StartBlock : int

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

Type

int

$Size

$Size : int

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

Type

int

$_data

$_data : string

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

Type

string

$children

$children : array

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

Type

array

$ole

$ole : \OLE

Pointer to OLE container

Type

\OLE —

$_tmp_dir

$_tmp_dir : string

Directory for temporary files

Type

string

Methods

__construct()

__construct(int  $time_1st, int  $time_2nd, mixed  $raChild) : mixed

The constructor

Parameters

int $time_1st

A timestamp

int $time_2nd

A timestamp

mixed $raChild

Returns

mixed —

_DataLen()

_DataLen() : int

Returns the amount of data saved for this PPS

Returns

int —

The amount of data (in bytes)

_getPpsWk()

_getPpsWk() : string

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

Returns

string —

The binary string

_savePpsSetPnt()

_savePpsSetPnt(array  $raList, mixed  $to_save, mixed  $depth) : int

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

array $raList

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

mixed $to_save
mixed $depth

Returns

int —

The index for this PPS

save()

save(string|resource  $filename) : mixed

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.

Returns

mixed —

true on success

_calcSize()

_calcSize(array  $raList) : array

Calculate some numbers

Parameters

array $raList

Reference to an array of PPS's

Returns

array —

The array of numbers

_saveHeader()

_saveHeader(int  $iSBDcnt, int  $iBBcnt, int  $iPPScnt) : mixed

Save OLE header

Parameters

int $iSBDcnt
int $iBBcnt
int $iPPScnt

Returns

mixed —

_saveBigData()

_saveBigData(int  $iStBlk, array  $raList) : mixed

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

Parameters

int $iStBlk
array $raList

Reference to array of PPS's

Returns

mixed —

_makeSmallData()

_makeSmallData(array  $raList) : mixed

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

Parameters

array $raList

Reference to array of PPS's

Returns

mixed —

_savePps()

_savePps(array  $raList) : mixed

Saves all the PPS's WKs

Parameters

array $raList

Reference to an array with all PPS's

Returns

mixed —

_saveBbd()

_saveBbd(int  $iSbdSize, int  $iBsize, int  $iPpsCnt) : mixed

Saving Big Block Depot

Parameters

int $iSbdSize
int $iBsize
int $iPpsCnt

Returns

mixed —

_adjust2()

_adjust2(int  $i2) : int

Helper function for caculating a magic value for block sizes

Parameters

int $i2

The argument

Returns

int —