OLE_PPS_Root Class Reference

Inheritance diagram for OLE_PPS_Root:

Collaboration diagram for OLE_PPS_Root:

Public Member Functions
	OLE_PPS_Root ($time_1st, $time_2nd, $raChild)
	setTempDir ($dir)
	save ($filename)
	_calcSize (&$raList)
	_adjust2 ($i2)
	_saveHeader ($iSBDcnt, $iBBcnt, $iPPScnt)
	_saveBigData ($iStBlk, &$raList)
	_makeSmallData (&$raList)
	_savePps (&$raList)
	_saveBbd ($iSbdSize, $iBsize, $iPpsCnt)
Data Fields
	$_tmp_dir

---

Detailed Description

Definition at line 32 of file Root.php.

---

Member Function Documentation

_adjust2

(

$

i2

)

Helper function for caculating a magic value for block sizes

private

Parameters:

integer

$i2

The argument

See also:

save()

Returns:

integer

Definition at line 190 of file Root.php.

Here is the caller graph for this function:

_calcSize

(

&$

raList

)

Calculate some numbers

private

Parameters:

array

$raList

Reference to an array of PPS's

Returns:

array The array of numbers

Definition at line 151 of file Root.php.

Here is the caller graph for this function:

_makeSmallData

(

&$

raList

)

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

private

Parameters:

array

&$raList

Reference to array of PPS's

Definition at line 344 of file Root.php.

Here is the caller graph for this function:

_saveBbd	(	$	iSbdSize,
		$	iBsize,
		$	iPpsCnt
	)

Saving Big Block Depot

private

Parameters:

integer	$iSbdSize
integer	$iBsize
integer	$iPpsCnt

Definition at line 432 of file Root.php.

Here is the caller graph for this function:

_saveBigData	(	$	iStBlk,
		&$	raList
	)

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

private

Parameters:

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

Definition at line 287 of file Root.php.

Here is the caller graph for this function:

_saveHeader	(	$	iSBDcnt,
		$	iBBcnt,
		$	iPPScnt
	)

Save OLE header

private

Parameters:

integer	$iSBDcnt
integer	$iBBcnt
integer	$iPPScnt

Definition at line 204 of file Root.php.

Here is the caller graph for this function:

_savePps

(

&$

raList

)

Saves all the PPS's WKs

private

Parameters:

array

$raList

Reference to an array with all PPS's

Definition at line 407 of file Root.php.

Here is the call graph for this function:

Here is the caller graph for this function:

OLE_PPS_Root	(	$	time_1st,
		$	time_2nd,
		$	raChild
	)

Constructor

public

Parameters:

integer	$time_1st	A timestamp
integer	$time_2nd	A timestamp

Definition at line 47 of file Root.php.

Here is the call graph for this function:

save

(

$

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.

Parameters:

string

$filename

The name of the file where to save the OLE container public

Returns:

mixed true on success, PEAR_Error on failure

Definition at line 88 of file Root.php.

Here is the call graph for this function:

setTempDir

(

$

dir

)

Sets the temp dir used for storing the OLE file

public

Parameters:

string

$dir

The dir to be used as temp dir

Returns:

true if given dir is valid, false otherwise

Definition at line 70 of file Root.php.

---

Field Documentation

$_tmp_dir

Definition at line 38 of file Root.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/pear/OLE/PPS/Root.php