PHPExcel_Shared_OLE_PPS Class Reference

Inheritance diagram for PHPExcel_Shared_OLE_PPS:

Collaboration diagram for PHPExcel_Shared_OLE_PPS:

Public Member Functions
	__construct ($No, $name, $type, $prev, $next, $dir, $time_1st, $time_2nd, $data, $children)
	The constructor. More...
	_DataLen ()
	Returns the amount of data saved for this PPS. More...
	_getPpsWk ()
	Returns a string with the PPS's WK (What is a WK?) More...

Static Public Member Functions
static	_savePpsSetPnt (&$raList, $to_save, $depth=0)
	Updates index and pointers to previous, next and children PPS's for this PPS. More...

Data Fields
	$No
	$Name
	$Type
	$PrevPps
	$NextPps
	$DirPps
	$Time1st
	$Time2nd
	$_StartBlock
	$Size
	$_data
	$children = array()
	$ole

Detailed Description

Definition at line 30 of file PPS.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Shared_OLE_PPS::__construct	(		$No,
			$name,
			$type,
			$prev,
			$next,
			$dir,
			$time_1st,
			$time_2nd,
			$data,
			$children
	)

The constructor.

@access public

Parameters

integer	$No	The PPS index
string	$name	The PPS name
integer	$type	The PPS type. Dir, Root or File
integer	$prev	The index of the previous PPS
integer	$next	The index of the next PPS
integer	$dir	The index of it's first child if this is a Dir or Root PPS
integer	$time_1st	A timestamp
integer	$time_2nd	A timestamp
string	$data	The (usually binary) source data of the PPS
array	$children	Array containing children PPS for this PPS

Definition at line 125 of file PPS.php.

        {
                $this->No      = $No;
                $this->Name    = $name;
                $this->Type    = $type;
                $this->PrevPps = $prev;
                $this->NextPps = $next;
                $this->DirPps  = $dir;
                $this->Time1st = $time_1st;
                $this->Time2nd = $time_2nd;
                $this->_data      = $data;
                $this->children   = $children;
                if ($data != '') {
                        $this->Size = strlen($data);
                } else {
                        $this->Size = 0;
                }
        }

References $children, $data, and $No.

Member Function Documentation

_DataLen()

PHPExcel_Shared_OLE_PPS::_DataLen

(

)

Returns the amount of data saved for this PPS.

@access public

Returns

integer The amount of data (in bytes)

Definition at line 150 of file PPS.php.

        {
                if (!isset($this->_data)) {
                        return 0;
                }
                //if (isset($this->_PPS_FILE)) {
                //      fseek($this->_PPS_FILE, 0);
                //      $stats = fstat($this->_PPS_FILE);
                //      return $stats[7];
                //} else {
                        return strlen($this->_data);
                //}
        }

_getPpsWk()

PHPExcel_Shared_OLE_PPS::_getPpsWk

(

)

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

@access public

Returns

string The binary string

Definition at line 170 of file PPS.php.

        {
                $ret = str_pad($this->Name,64,"\x00");
 
                $ret .= pack("v", strlen($this->Name) + 2)  // 66
                          . pack("c", $this->Type)              // 67
                          . pack("c", 0x00) //UK                // 68
                          . pack("V", $this->PrevPps) //Prev    // 72
                          . pack("V", $this->NextPps) //Next    // 76
                          . pack("V", $this->DirPps)  //Dir     // 80
                          . "\x00\x09\x02\x00"                  // 84
                          . "\x00\x00\x00\x00"                  // 88
                          . "\xc0\x00\x00\x00"                  // 92
                          . "\x00\x00\x00\x46"                  // 96 // Seems to be ok only for Root
                          . "\x00\x00\x00\x00"                  // 100
                          . PHPExcel_Shared_OLE::LocalDate2OLE($this->Time1st)       // 108
                          . PHPExcel_Shared_OLE::LocalDate2OLE($this->Time2nd)       // 116
                          . pack("V", isset($this->_StartBlock)?
                                                $this->_StartBlock:0)        // 120
                          . pack("V", $this->Size)               // 124
                          . pack("V", 0);                        // 128
                return $ret;
        }

References $ret, and PHPExcel_Shared_OLE\LocalDate2OLE().

Referenced by PHPExcel_Shared_OLE_PPS_Root\_savePps().

Here is the call graph for this function:

Here is the caller graph for this function:

_savePpsSetPnt()

static PHPExcel_Shared_OLE_PPS::_savePpsSetPnt ( &  $raList,   $to_save,   $depth = 0  )

static

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.

@access public

Parameters

array

&$raList

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

Returns

integer The index for this PPS

Definition at line 203 of file PPS.php.

        {
                if ( !is_array($to_save) || (empty($to_save)) ) {
                        return 0xFFFFFFFF;
                } elseif( count($to_save) == 1 ) {
                        $cnt = count($raList);
                        // If the first entry, it's the root... Don't clone it!
                        $raList[$cnt] = ( $depth == 0 ) ? $to_save[0] : clone $to_save[0];
                        $raList[$cnt]->No = $cnt;
                        $raList[$cnt]->PrevPps = 0xFFFFFFFF;
                        $raList[$cnt]->NextPps = 0xFFFFFFFF;
                        $raList[$cnt]->DirPps  = self::_savePpsSetPnt($raList, @$raList[$cnt]->children, $depth++);
                } else {
                        $iPos  = floor(count($to_save) / 2);
                        $aPrev = array_slice($to_save, 0, $iPos);
                        $aNext = array_slice($to_save, $iPos + 1);
                        $cnt   = count($raList);
                        // If the first entry, it's the root... Don't clone it!
                        $raList[$cnt] = ( $depth == 0 ) ? $to_save[$iPos] : clone $to_save[$iPos];
                        $raList[$cnt]->No = $cnt;
                        $raList[$cnt]->PrevPps = self::_savePpsSetPnt($raList, $aPrev, $depth++);
                        $raList[$cnt]->NextPps = self::_savePpsSetPnt($raList, $aNext, $depth++);
                        $raList[$cnt]->DirPps  = self::_savePpsSetPnt($raList, @$raList[$cnt]->children, $depth++);
 
                }
                return $cnt;
        }

References _savePpsSetPnt().

Referenced by _savePpsSetPnt(), and PHPExcel_Shared_OLE_PPS_Root\save().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_data

PHPExcel_Shared_OLE_PPS::$_data

Definition at line 96 of file PPS.php.

$_StartBlock

PHPExcel_Shared_OLE_PPS::$_StartBlock

Definition at line 84 of file PPS.php.

$children

PHPExcel_Shared_OLE_PPS::$children = array()

Definition at line 102 of file PPS.php.

Referenced by __construct().

$DirPps

PHPExcel_Shared_OLE_PPS::$DirPps

Definition at line 66 of file PPS.php.

$Name

PHPExcel_Shared_OLE_PPS::$Name

Definition at line 42 of file PPS.php.

$NextPps

PHPExcel_Shared_OLE_PPS::$NextPps

Definition at line 60 of file PPS.php.

$No

PHPExcel_Shared_OLE_PPS::$No

Definition at line 36 of file PPS.php.

Referenced by __construct().

$ole

PHPExcel_Shared_OLE_PPS::$ole

Definition at line 108 of file PPS.php.

$PrevPps

PHPExcel_Shared_OLE_PPS::$PrevPps

Definition at line 54 of file PPS.php.

$Size

PHPExcel_Shared_OLE_PPS::$Size

Definition at line 90 of file PPS.php.

$Time1st

PHPExcel_Shared_OLE_PPS::$Time1st

Definition at line 72 of file PPS.php.

$Time2nd

PHPExcel_Shared_OLE_PPS::$Time2nd

Definition at line 78 of file PPS.php.

$Type

PHPExcel_Shared_OLE_PPS::$Type

Definition at line 48 of file PPS.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/OLE/PPS.php