class PHPExcel_Shared_OLE_PPS in Loft Data Grids 7.2

Class for creating PPS's for OLE containers

@author Xavier Noguer <[e-mail]> @category PHPExcel @package PHPExcel_Shared_OLE

Hierarchy

• class \PHPExcel_Shared_OLE_PPS

File

vendor/phpoffice/phpexcel/Classes/PHPExcel/Shared/OLE/PPS.php, line 30

class PHPExcel_Shared_OLE_PPS {

  /**
   * The PPS index
   * @var integer
   */
  public $No;

  /**
   * The PPS name (in Unicode)
   * @var string
   */
  public $Name;

  /**
   * The PPS type. Dir, Root or File
   * @var integer
   */
  public $Type;

  /**
   * The index of the previous PPS
   * @var integer
   */
  public $PrevPps;

  /**
   * The index of the next PPS
   * @var integer
   */
  public $NextPps;

  /**
   * The index of it's first child if this is a Dir or Root PPS
   * @var integer
   */
  public $DirPps;

  /**
   * A timestamp
   * @var integer
   */
  public $Time1st;

  /**
   * A timestamp
   * @var integer
   */
  public $Time2nd;

  /**
   * Starting block (small or big) for this PPS's data  inside the container
   * @var integer
   */
  public $_StartBlock;

  /**
   * The size of the PPS's data (in bytes)
   * @var integer
   */
  public $Size;

  /**
   * The PPS's data (only used if it's not using a temporary file)
   * @var string
   */
  public $_data;

  /**
   * Array of child PPS's (only used by Root and Dir PPS's)
   * @var array
   */
  public $children = array();

  /**
   * Pointer to OLE container
   * @var OLE
   */
  public $ole;

  /**
   * The constructor
   *
   * @access public
   * @param integer $No   The PPS index
   * @param string  $name The PPS name
   * @param integer $type The PPS type. Dir, Root or File
   * @param integer $prev The index of the previous PPS
   * @param integer $next The index of the next PPS
   * @param integer $dir  The index of it's first child if this is a Dir or Root PPS
   * @param integer $time_1st A timestamp
   * @param integer $time_2nd A timestamp
   * @param string  $data  The (usually binary) source data of the PPS
   * @param array   $children Array containing children PPS for this PPS
   */
  public function __construct($No, $name, $type, $prev, $next, $dir, $time_1st, $time_2nd, $data, $children) {
    $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;
    }
  }

  /**
   * Returns the amount of data saved for this PPS
   *
   * @access public
   * @return integer The amount of data (in bytes)
   */
  public function _DataLen() {
    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);

    //}
  }

  /**
   * Returns a string with the PPS's WK (What is a WK?)
   *
   * @access public
   * @return string The binary string
   */
  public function _getPpsWk() {
    $ret = str_pad($this->Name, 64, "\0");
    $ret .= pack("v", strlen($this->Name) + 2) . pack("c", $this->Type) . pack("c", 0x0) . pack("V", $this->PrevPps) . pack("V", $this->NextPps) . pack("V", $this->DirPps) . "\0\t\2\0" . "\0\0\0\0" . "" . "\0\0\0F" . "\0\0\0\0" . PHPExcel_Shared_OLE::LocalDate2OLE($this->Time1st) . PHPExcel_Shared_OLE::LocalDate2OLE($this->Time2nd) . pack("V", isset($this->_StartBlock) ? $this->_StartBlock : 0) . pack("V", $this->Size) . pack("V", 0);

    // 128
    return $ret;
  }

  /**
   * 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
   * @param array &$raList Reference to the array of PPS's for the whole OLE
   *                          container
   * @return integer          The index for this PPS
   */
  public static function _savePpsSetPnt(&$raList, $to_save, $depth = 0) {
    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;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPExcel_Shared_OLE_PPS::$children	public	property	* Array of child PPS's (only used by Root and Dir PPS's) *
PHPExcel_Shared_OLE_PPS::$DirPps	public	property	* The index of it's first child if this is a Dir or Root PPS *
PHPExcel_Shared_OLE_PPS::$Name	public	property	* The PPS name (in Unicode) *
PHPExcel_Shared_OLE_PPS::$NextPps	public	property	* The index of the next PPS *
PHPExcel_Shared_OLE_PPS::$No	public	property	* The PPS index *
PHPExcel_Shared_OLE_PPS::$ole	public	property	* Pointer to OLE container *
PHPExcel_Shared_OLE_PPS::$PrevPps	public	property	* The index of the previous PPS *
PHPExcel_Shared_OLE_PPS::$Size	public	property	* The size of the PPS's data (in bytes) *
PHPExcel_Shared_OLE_PPS::$Time1st	public	property	* A timestamp *
PHPExcel_Shared_OLE_PPS::$Time2nd	public	property	* A timestamp *
PHPExcel_Shared_OLE_PPS::$Type	public	property	* The PPS type. Dir, Root or File *
PHPExcel_Shared_OLE_PPS::$_data	public	property	* The PPS's data (only used if it's not using a temporary file) *
PHPExcel_Shared_OLE_PPS::$_StartBlock	public	property	* Starting block (small or big) for this PPS's data inside the container *
PHPExcel_Shared_OLE_PPS::_DataLen	public	function	* Returns the amount of data saved for this PPS * * @access public *
PHPExcel_Shared_OLE_PPS::_getPpsWk	public	function	* Returns a string with the PPS's WK (What is a WK?) * * @access public *
PHPExcel_Shared_OLE_PPS::_savePpsSetPnt	public static	function	* 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 *
PHPExcel_Shared_OLE_PPS::__construct	public	function	* The constructor * * @access public *	2