PHPExcel_Shared_OLE
[ class tree: PHPExcel_Shared_OLE ] [ index: PHPExcel_Shared_OLE ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
ChainedBlockStream.php
OLE.php
OLE_File.php
OLE_PPS.php
OLE_Root.php

Classes:
PHPExcel_Shared_OLE
PHPExcel_Shared_OLE_ChainedBlockStream
PHPExcel_Shared_OLE_PPS
PHPExcel_Shared_OLE_PPS_File
PHPExcel_Shared_OLE_PPS_Root

Class: PHPExcel_Shared_OLE_PPS_Root

Source Location: /PHPExcel/Shared/OLE/OLE_Root.php

Class Overview

PHPExcel_Shared_OLE_PPS
   |
   --PHPExcel_Shared_OLE_PPS_Root

Class for creating Root PPS's for OLE containers


Author(s):

Variables

Methods

Inherited Variables

Class: PHPExcel_Shared_OLE_PPS

PHPExcel_Shared_OLE_PPS::$children
PHPExcel_Shared_OLE_PPS::$DirPps
PHPExcel_Shared_OLE_PPS::$Name
PHPExcel_Shared_OLE_PPS::$NextPps
PHPExcel_Shared_OLE_PPS::$No
PHPExcel_Shared_OLE_PPS::$ole
PHPExcel_Shared_OLE_PPS::$PrevPps
PHPExcel_Shared_OLE_PPS::$Size
PHPExcel_Shared_OLE_PPS::$Time1st
PHPExcel_Shared_OLE_PPS::$Time2nd
PHPExcel_Shared_OLE_PPS::$Type
PHPExcel_Shared_OLE_PPS::$_data
PHPExcel_Shared_OLE_PPS::$_StartBlock

Inherited Methods

Class: PHPExcel_Shared_OLE_PPS

PHPExcel_Shared_OLE_PPS::__construct()
The constructor
PHPExcel_Shared_OLE_PPS::_DataLen()
Returns the amount of data saved for this PPS
PHPExcel_Shared_OLE_PPS::_getPpsWk()
Returns a string with the PPS's WK (What is a WK?)
PHPExcel_Shared_OLE_PPS::_savePpsSetPnt()
Updates index and pointers to previous, next and children PPS's for this PPS.

Class Details

[line 32]
Class for creating Root PPS's for OLE containers

Class for creating Root PPS's for OLE containers




Tags:

author:  Xavier Noguer <xnoguer@php.net>


[ Top ]

Class Variables

$_tmp_dir =

[line 38]

The temporary dir for storing the OLE file

The temporary dir for storing the OLE file




Tags:

access:  public

Type:   string


[ Top ]


Class Methods

constructor __construct [line 44]

PHPExcel_Shared_OLE_PPS_Root __construct( integer $time_1st, integer $time_2nd, $raChild)



Tags:

access:  public


Overrides PHPExcel_Shared_OLE_PPS::__construct() (The constructor)

Parameters:

integer   $time_1st   A timestamp
integer   $time_2nd   A timestamp
   $raChild  

[ Top ]

method save [line 85]

mixed save( string $filename)

Method for saving the whole OLE container (including files).

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.




Tags:

return:  true on success
access:  public


Parameters:

string   $filename   The name of the file where to save the OLE container

[ Top ]

method setTempDir [line 67]

true setTempDir( string $dir)

Sets the temp dir used for storing the OLE file

Sets the temp dir used for storing the OLE file




Tags:

return:  if given dir is valid, false otherwise
access:  public


Parameters:

string   $dir   The dir to be used as temp dir

[ Top ]

method _adjust2 [line 182]

integer _adjust2( integer $i2)

Helper function for caculating a magic value for block sizes

Helper function for caculating a magic value for block sizes




Tags:

see:  PHPExcel_Shared_OLE_PPS_Root::save()
access:  public


Parameters:

integer   $i2   The argument

[ Top ]

method _calcSize [line 144]

array _calcSize( &$raList, array $raList)

Calculate some numbers

Calculate some numbers




Tags:

return:  The array of numbers
access:  public


Parameters:

array   $raList   Reference to an array of PPS's
   &$raList  

[ Top ]

method _makeSmallData [line 323]

void _makeSmallData( array &$raList)

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

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




Tags:

access:  public


Parameters:

array   &$raList   Reference to array of PPS's

[ Top ]

method _saveBbd [line 403]

void _saveBbd( integer $iSbdSize, integer $iBsize, integer $iPpsCnt)

Saving Big Block Depot

Saving Big Block Depot




Tags:

access:  public


Parameters:

integer   $iSbdSize  
integer   $iBsize  
integer   $iPpsCnt  

[ Top ]

method _saveBigData [line 273]

void _saveBigData( integer $iStBlk, array &$raList)

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

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




Tags:

access:  public


Parameters:

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

[ Top ]

method _saveHeader [line 196]

void _saveHeader( integer $iSBDcnt, integer $iBBcnt, integer $iPPScnt)

Save OLE header

Save OLE header




Tags:

access:  public


Parameters:

integer   $iSBDcnt  
integer   $iBBcnt  
integer   $iPPScnt  

[ Top ]

method _savePps [line 379]

void _savePps( &$raList, array $raList)

Saves all the PPS's WKs

Saves all the PPS's WKs




Tags:

access:  public


Parameters:

array   $raList   Reference to an array with all PPS's
   &$raList  

[ Top ]

Documentation generated on Mon, 05 Jan 2009 20:38:14 +0100 by phpDocumentor 1.4.1