\PHPExcel_Shared_OLE_PPS_File

Class for creating File PPS's for OLE containers

Summary

Methods
Properties
Constants
__construct()
_DataLen()
_getPpsWk()
_savePpsSetPnt()
init()
append()
getStream()
$No
$Name
$Type
$PrevPps
$NextPps
$DirPps
$Time1st
$Time2nd
$_StartBlock
$Size
$_data
$children
$ole
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$No

$No : integer

The PPS index

Type

integer

$Name

$Name : string

The PPS name (in Unicode)

Type

string

$Type

$Type : integer

The PPS type. Dir, Root or File

Type

integer

$PrevPps

$PrevPps : integer

The index of the previous PPS

Type

integer

$NextPps

$NextPps : integer

The index of the next PPS

Type

integer

$DirPps

$DirPps : integer

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

Type

integer

$Time1st

$Time1st : integer

A timestamp

Type

integer

$Time2nd

$Time2nd : integer

A timestamp

Type

integer

$_StartBlock

$_StartBlock : integer

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

Type

integer

$Size

$Size : integer

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

Type

integer

$_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

Methods

__construct()

__construct(string  $name) 

The constructor

Parameters

string $name

The name of the file (in Unicode)

_DataLen()

_DataLen() : integer

Returns the amount of data saved for this PPS

Returns

integer —

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(  $raList,   $to_save,   $depth) : integer

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

Returns

integer —

The index for this PPS

init()

init() : mixed

Initialization method. Has to be called right after OLE_PPS_File().

Returns

mixed —

true on success

append()

append(string  $data) 

Append data to PPS

Parameters

string $data

The data to append

getStream()

getStream() : resource

Returns a stream for reading this file using fread() etc.

Returns

resource —

a read-only stream