\PhpOffice\PhpSpreadsheet\Shared\OLE\PPSFile

Class for creating File PPS's for OLE containers.

Summary

Methods
Properties
Constants
__construct()
getDataLen()
getPpsWk()
savePpsSetPnt()
init()
append()
$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 : 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 : \PhpOffice\PhpSpreadsheet\Shared\OLE

Pointer to OLE container.

Type

OLE

Methods

__construct()

__construct(string  $name) : mixed

The constructor.

Parameters

string $name

The name of the file (in Unicode)

Returns

mixed —

getDataLen()

getDataLen() : 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

init()

init() : mixed

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

Returns

mixed —

true on success

append()

append(string  $data) : void

Append data to PPS.

Parameters

string $data

The data to append