Package PHPExcel_Shared_OLE Element Index

PHPExcel_Shared_OLE

# Element index for package PHPExcel_Shared_OLE

[ a ] [ b ] [ c ] [ d ] [ f ] [ g ] [ i ] [ l ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ _ ]

## _

$_data
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$_data
  The PPS's data (only used if it's not using a temporary file)
$_file_handle
  in file OLE.php, variable PHPExcel_Shared_OLE::$_file_handle
  The file handle for reading an OLE container
$_list
  in file OLE.php, variable PHPExcel_Shared_OLE::$_list
  Array of PPS's found on the OLE container
$_StartBlock
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$_StartBlock
  Starting block (small or big) for this PPS's data inside the container
$_tmp_dir
  in file Root.php, variable PHPExcel_Shared_OLE_PPS_Root::$_tmp_dir
  Directory for temporary files
_calcSize
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::_calcSize()
  Calculate some numbers
_DataLen
  in file PPS.php, method PHPExcel_Shared_OLE_PPS::_DataLen()
  Returns the amount of data saved for this PPS
_getBlockOffset
  in file OLE.php, method PHPExcel_Shared_OLE::_getBlockOffset()
_getPpsWk
  in file PPS.php, method PHPExcel_Shared_OLE_PPS::_getPpsWk()
  Returns a string with the PPS's WK (What is a WK?)
_makeSmallData
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::_makeSmallData()
  get small data (PPS's with data smaller than PHPExcel_Shared_OLE::OLE_DATA_SIZE_SMALL)
_ppsTreeComplete
  in file OLE.php, method PHPExcel_Shared_OLE::_ppsTreeComplete()
  It checks whether the PPS tree is complete (all PPS's read) starting with the given PPS (not necessarily root)
_readPpsWks
  in file OLE.php, method PHPExcel_Shared_OLE::_readPpsWks()
  Gets information about all PPS's on the OLE container from the PPS WK's creates an OLE_PPS object for each one.
_saveBbd
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::_saveBbd()
  Saving Big Block Depot
_saveBigData
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::_saveBigData()
  Saving big data (PPS's with data bigger than PHPExcel_Shared_OLE::OLE_DATA_SIZE_SMALL)
_saveHeader
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::_saveHeader()
  Save OLE header
_savePps
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::_savePps()
  Saves all the PPS's WKs
_savePpsSetPnt
  in file PPS.php, method PHPExcel_Shared_OLE_PPS::_savePpsSetPnt()
  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.
__construct
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::__construct()
__construct
  in file PPS.php, method PHPExcel_Shared_OLE_PPS::__construct()
  The constructor
__construct
  in file File.php, method PHPExcel_Shared_OLE_PPS_File::__construct()
  The constructor

top

## a

append
  in file File.php, method PHPExcel_Shared_OLE_PPS_File::append()
  Append data to PPS
Asc2Ucs
  in file OLE.php, method PHPExcel_Shared_OLE::Asc2Ucs()
  Utility function to transform ASCII text to Unicode

top

## b

$bbat
  in file OLE.php, variable PHPExcel_Shared_OLE::$bbat
  Big Block Allocation Table
$bigBlockSize
  in file OLE.php, variable PHPExcel_Shared_OLE::$bigBlockSize
  Size of big blocks. This is usually 512.

top

## c

$children
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$children
  Array of child PPS's (only used by Root and Dir PPS's)
ChainedBlockStream.php
  procedural page ChainedBlockStream.php

top

## d

$data
  in file ChainedBlockStream.php, variable PHPExcel_Shared_OLE_ChainedBlockStream::$data
  The binary data of the file.
$DirPps
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$DirPps
  The index of it's first child if this is a Dir or Root PPS

top

## f

File.php
  procedural page File.php

top

## g

getData
  in file OLE.php, method PHPExcel_Shared_OLE::getData()
  Gets data from a PPS If there is no PPS for the index given, it will return an empty string.
getDataLength
  in file OLE.php, method PHPExcel_Shared_OLE::getDataLength()
  Gets the data length from a PPS If there is no PPS for the index given, it will return 0.
getStream
  in file OLE.php, method PHPExcel_Shared_OLE::getStream()
  Returns a stream for use with fread() etc. External callers should use PHPExcel_Shared_OLE_PPS_File::getStream().
getStream
  in file File.php, method PHPExcel_Shared_OLE_PPS_File::getStream()
  Returns a stream for reading this file using fread() etc.

top

## i

init
  in file File.php, method PHPExcel_Shared_OLE_PPS_File::init()
  Initialization method. Has to be called right after OLE_PPS_File().
isFile
  in file OLE.php, method PHPExcel_Shared_OLE::isFile()
  Checks whether a PPS is a File PPS or not.
isRoot
  in file OLE.php, method PHPExcel_Shared_OLE::isRoot()
  Checks whether a PPS is a Root PPS or not.

top

## l

LocalDate2OLE
  in file OLE.php, method PHPExcel_Shared_OLE::LocalDate2OLE()
  Utility function Returns a string for the OLE container with the date given

top

## n

$Name
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$Name
  The PPS name (in Unicode)
$NextPps
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$NextPps
  The index of the next PPS
$No
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$No
  The PPS index

top

## o

$ole
  in file ChainedBlockStream.php, variable PHPExcel_Shared_OLE_ChainedBlockStream::$ole
  The OLE container of the file that is being read.
$ole
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$ole
  Pointer to OLE container
OLE2LocalDate
  in file OLE.php, method PHPExcel_Shared_OLE::OLE2LocalDate()
  Returns a timestamp from an OLE container's date
OLE_DATA_SIZE_SMALL
  in file OLE.php, class constant PHPExcel_Shared_OLE::OLE_DATA_SIZE_SMALL
OLE_LONG_INT_SIZE
  in file OLE.php, class constant PHPExcel_Shared_OLE::OLE_LONG_INT_SIZE
OLE_PPS_SIZE
  in file OLE.php, class constant PHPExcel_Shared_OLE::OLE_PPS_SIZE
OLE_PPS_TYPE_DIR
  in file OLE.php, class constant PHPExcel_Shared_OLE::OLE_PPS_TYPE_DIR
OLE_PPS_TYPE_FILE
  in file OLE.php, class constant PHPExcel_Shared_OLE::OLE_PPS_TYPE_FILE
OLE_PPS_TYPE_ROOT
  in file OLE.php, class constant PHPExcel_Shared_OLE::OLE_PPS_TYPE_ROOT
OLE.php
  procedural page OLE.php

top

## p

$params
  in file ChainedBlockStream.php, variable PHPExcel_Shared_OLE_ChainedBlockStream::$params
  Parameters specified by fopen().
$pos
  in file ChainedBlockStream.php, variable PHPExcel_Shared_OLE_ChainedBlockStream::$pos
  The file pointer.
$PrevPps
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$PrevPps
  The index of the previous PPS
PPS.php
  procedural page PPS.php
PHPExcel_Shared_OLE
  in file OLE.php, class PHPExcel_Shared_OLE
  OLE package base class.
PHPExcel_Shared_OLE_ChainedBlockStream
  in file ChainedBlockStream.php, class PHPExcel_Shared_OLE_ChainedBlockStream
  PHPExcel_Shared_OLE_ChainedBlockStream
PHPExcel_Shared_OLE_PPS
  in file PPS.php, class PHPExcel_Shared_OLE_PPS
  Class for creating PPS's for OLE containers
PHPExcel_Shared_OLE_PPS_File
  in file File.php, class PHPExcel_Shared_OLE_PPS_File
  Class for creating File PPS's for OLE containers
PHPExcel_Shared_OLE_PPS_Root
  in file Root.php, class PHPExcel_Shared_OLE_PPS_Root
  Class for creating Root PPS's for OLE containers
ppsTotal
  in file OLE.php, method PHPExcel_Shared_OLE::ppsTotal()
  Gives the total number of PPS's found in the OLE container.

top

## r

$root
  in file OLE.php, variable PHPExcel_Shared_OLE::$root
  Root directory of OLE container
Root.php
  procedural page Root.php
read
  in file OLE.php, method PHPExcel_Shared_OLE::read()
  Reads an OLE container from the contents of the file given.

top

## s

$sbat
  in file OLE.php, variable PHPExcel_Shared_OLE::$sbat
  Short Block Allocation Table
$Size
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$Size
  The size of the PPS's data (in bytes)
$smallBlockSize
  in file OLE.php, variable PHPExcel_Shared_OLE::$smallBlockSize
  Size of small blocks. This is usually 64.
save
  in file Root.php, method PHPExcel_Shared_OLE_PPS_Root::save()
  Method for saving the whole OLE container (including files).
stream_close
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_close()
  Implements support for fclose().
stream_eof
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_eof()
  Implements support for feof().
stream_open
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_open()
  Implements support for fopen().
stream_read
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_read()
  Implements support for fread(), fgets() etc.
stream_seek
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_seek()
  Implements support for fseek().
stream_stat
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_stat()
  Implements support for fstat(). Currently the only supported field is "size".
stream_tell
  in file ChainedBlockStream.php, method PHPExcel_Shared_OLE_ChainedBlockStream::stream_tell()
  Returns the position of the file pointer, i.e. its offset into the file stream. Implements support for ftell().

top

## t

$Time1st
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$Time1st
  A timestamp
$Time2nd
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$Time2nd
  A timestamp
$Type
  in file PPS.php, variable PHPExcel_Shared_OLE_PPS::$Type
  The PPS type. Dir, Root or File

top

Documentation generated on Sun, 27 Feb 2011 16:26:38 -0800 by phpDocumentor 1.4.3