PHPExcel_Reader
[ class tree: PHPExcel_Reader ] [ index: PHPExcel_Reader ] [ all elements ]

Class: PHPExcel_Reader_Excel5

Source Location: /PHPExcel/Reader/Excel5.php

Class Overview


PHPExcel_Reader_Excel5


Author(s):

Copyright:

  • Copyright (c) 2006 - 2008 PHPExcel (http://www.codeplex.com/PHPExcel)

Implements interfaces:

Variables

Constants

Methods



Class Details

[line 88]
PHPExcel_Reader_Excel5

PHPExcel_Reader_Excel5 This class uses http://sourceforge.net/projects/phpexcelreader/parseXL




Tags:

copyright:  Copyright (c) 2006 - 2008 PHPExcel (http://www.codeplex.com/PHPExcel)


[ Top ]


Class Variables

$_boundsheets = array()

[line 248]

Worksheets

Worksheets




Tags:

access:  private

Type:   array


[ Top ]

$_codepage =

[line 220]

Codepage set in the Excel file being read.

Codepage set in the Excel file being read. Only important for BIFF5 (Excel 5.0 - Excel 95) For BIFF8 (Excel 97 - Excel 2003) this will always have the value 'UTF-16LE'




Tags:

access:  private

Type:   string


[ Top ]

$_data =

[line 184]

Stream data that is read.

Stream data that is read. Includes workbook globals substream as well as sheet substreams




Tags:

access:  private

Type:   string


[ Top ]

$_definedname = array()

[line 269]

Defined names

Defined names




Tags:

access:  private

Type:   array


[ Top ]

$_excel =

[line 198]

Workbook to be returned by the reader.

Workbook to be returned by the reader.




Tags:

access:  private

Type:   PHPExcel


[ Top ]

$_externalBooks = array()

[line 255]

External books

External books




Tags:

access:  private

Type:   array


[ Top ]

$_extshref = array()

[line 281]



Tags:

access:  private

Type:   mixed


[ Top ]

$_fonts = array()

[line 227]

Shared fonts

Shared fonts




Tags:

access:  private

Type:   array


[ Top ]

$_formats = array()

[line 234]

Shared formats

Shared formats




Tags:

access:  private

Type:   array


[ Top ]

$_loadSheetsOnly =  null

[line 163]

Restict which sheets should be loaded?

Restict which sheets should be loaded?




Tags:

access:  private

Type:   array


[ Top ]

$_ole =

[line 177]

OLE reader

OLE reader




Tags:

access:  private



[ Top ]

$_pos =

[line 191]

Current position in stream

Current position in stream




Tags:

access:  private

Type:   integer


[ Top ]

$_readDataOnly =  false

[line 156]

Read data only?

Read data only?




Tags:

access:  private

Type:   boolean


[ Top ]

$_readFilter =  null

[line 170]

PHPExcel_Reader_IReadFilter instance

PHPExcel_Reader_IReadFilter instance




Tags:

access:  private



[ Top ]

$_ref = array()

[line 262]

REF structures.

REF structures. Only applies to BIFF8.




Tags:

access:  private

Type:   array


[ Top ]

$_sheet =

[line 205]

Worksheet that is currently being built by the reader.

Worksheet that is currently being built by the reader.




Tags:

access:  private

Type:   PHPExcel_Worksheet


[ Top ]

$_sst = array()

[line 276]

Shared strings.

Shared strings. Only applies to BIFF8.




Tags:

access:  private

Type:   array


[ Top ]

$_version =

[line 212]

BIFF version

BIFF version




Tags:

access:  private

Type:   int


[ Top ]

$_xf = array()

[line 241]

Shared styles

Shared styles




Tags:

access:  private

Type:   array


[ Top ]



Class Methods


method getLoadSheetsOnly [line 311]

mixed getLoadSheetsOnly( )

Get which sheets to load

Get which sheets to load




Tags:

access:  public


[ Top ]

method getReadDataOnly [line 291]

boolean getReadDataOnly( )

Read data only?

Read data only?




Tags:

access:  public


[ Top ]

method getReadFilter [line 340]

PHPExcel_Reader_IReadFilter getReadFilter( )

Read filter

Read filter




Tags:

access:  public


[ Top ]

method load [line 366]

void load( string $pFilename)

Loads PHPExcel from file

Loads PHPExcel from file




Tags:

throws:  Exception
access:  public



Implementation of:
PHPExcel_Reader_IReader::load()
Loads PHPExcel from file

Parameters:

string   $pFilename  

[ Top ]

method setLoadAllSheets [line 330]

void setLoadAllSheets( )

Set all sheets to load

Set all sheets to load




Tags:

access:  public


[ Top ]

method setLoadSheetsOnly [line 321]

void setLoadSheetsOnly( [mixed $value = null])

Set which sheets to load

Set which sheets to load




Tags:

access:  public


Parameters:

mixed   $value  

[ Top ]

method setReadDataOnly [line 301]

void setReadDataOnly( [boolean $pValue = false])

Set read data only

Set read data only




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method setReadFilter [line 349]

void setReadFilter( PHPExcel_Reader_IReadFilter $pValue)

Set read filter

Set read filter




Tags:

access:  public


Parameters:

PHPExcel_Reader_IReadFilter   $pValue  

[ Top ]

constructor __construct [line 356]

PHPExcel_Reader_Excel5 __construct( )

Create a new PHPExcel_Reader_Excel5 instance

Create a new PHPExcel_Reader_Excel5 instance




Tags:

access:  public


[ Top ]

method _createFormulaFromTokens [line 2701]

string _createFormulaFromTokens( array $tokens, array $additionalData)

Take array of tokens together with additional data for formula and return human readable formula

Take array of tokens together with additional data for formula and return human readable formula




Tags:

return:  Human readable formula
access:  private


Parameters:

array   $tokens  
array   $additionalData   Additional binary data going with the formula

[ Top ]

method _createNumber [line 3689]

void _createNumber( $spos)

Reads 8 bytes and returns IEEE 754 float

Reads 8 bytes and returns IEEE 754 float




Tags:

access:  private


Parameters:

   $spos  

[ Top ]

method _decodeCodepage [line 3806]

string _decodeCodepage( $string)

Convert string to UTF-8.

Convert string to UTF-8. Only used for BIFF5.




Tags:

access:  private


Parameters:

   $string  

[ Top ]

method _dump [line 4003]

void _dump( $data)

Dump a byte sequence, only used for debugging

Dump a byte sequence, only used for debugging




Tags:

access:  private


Parameters:

   $data  

[ Top ]

method _encodeUTF16 [line 3769]

string _encodeUTF16( $string, [ $compressed = ''])

Get UTF-8 string from (compressed or uncompressed) UTF-16 string

Get UTF-8 string from (compressed or uncompressed) UTF-16 string




Tags:

access:  private


Parameters:

   $string  
   $compressed  

[ Top ]

method _extractNumber [line 3715]

void _extractNumber( $subData)

Same as _createNumber, but not hardcoded to read from $this->_data

Same as _createNumber, but not hardcoded to read from $this->_data




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _getFormulaFromData [line 2676]

string _getFormulaFromData( string $formulaData, [string $additionalData = ''])

Take formula data and additional data for formula and return human readable formula

Take formula data and additional data for formula and return human readable formula




Tags:

return:  Human readable formula
access:  private


Parameters:

string   $formulaData   The binary data for the formula itself
string   $additionalData   Additional binary data going with the formula

[ Top ]

method _getFormulaFromStructure [line 2638]

string _getFormulaFromStructure( string $formulaStructure)

Convert formula structure into human readable Excel formula like 'A3+A5*5'

Convert formula structure into human readable Excel formula like 'A3+A5*5'




Tags:

return:  Human readable formula
access:  private


Parameters:

string   $formulaStructure   The complete binary data for the formula

[ Top ]

method _GetIEEE754 [line 3738]

void _GetIEEE754( $rknum)



Tags:

access:  private


Parameters:

   $rknum  

[ Top ]

method _GetInt2d [line 3827]

int _GetInt2d( $data, $pos)

Read 16-bit unsigned integer

Read 16-bit unsigned integer




Tags:

access:  private


Parameters:

   $data  
   $pos  

[ Top ]

method _GetInt4d [line 3837]

int _GetInt4d( $data, $pos)

Read 32-bit signed integer

Read 32-bit signed integer




Tags:

access:  private


Parameters:

   $data  
   $pos  

[ Top ]

method _getNextToken [line 2841]

void _getNextToken( string $formulaData)

Fetch next token from binary formula data

Fetch next token from binary formula data




Tags:

throws:  Exception
access:  private


Parameters:

string   $formulaData   Formula data

[ Top ]

method _getSplicedRecordData [line 2612]

string _getSplicedRecordData( )

Reads a record from current position in data stream and continues reading data as long as CONTINUE records are found. is in one piece.

Reads a record from current position in data stream and continues reading data as long as CONTINUE records are found. Splices the record data pieces and returns the combined string as if record data is in one piece. Moves to next current position in data stream to start of next record different from a CONtINUE record




Tags:

access:  private


[ Top ]

method _mapBorderStyle [line 3860]

string _mapBorderStyle( $index)

Map border style

Map border style OpenOffice documentation: 2.5.11




Tags:

access:  private


Parameters:

   $index  

[ Top ]

method _mapColor [line 3937]

array _mapColor( $subData)

Map color array from BIFF8 built-in color index

Map color array from BIFF8 built-in color index




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _mapErrorCode [line 3918]

string _mapErrorCode( $subData)

Map error code, e.

Map error code, e.g. '#N/A'




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _mapFillPattern [line 3887]

string _mapFillPattern( $index)

Get fill pattern from index

Get fill pattern from index OpenOffice documentation: 2.5.12




Tags:

access:  private


Parameters:

   $index  

[ Top ]

method _readBIFF8CellAddress [line 3340]

void _readBIFF8CellAddress( $cellAddressStructure)

Reads a cell address in BIFF8 e.

Reads a cell address in BIFF8 e.g. 'A2' or '$A$2' section 3.3.4




Tags:

access:  private


Parameters:

   $cellAddressStructure  

[ Top ]

method _readBIFF8CellRangeAddress [line 3390]

void _readBIFF8CellRangeAddress( $subData)

Reads a cell range address in BIFF8 e.

Reads a cell range address in BIFF8 e.g. 'A2:B6' or '$A$2:$B$6' there are flags indicating whether column/row index is relative section 3.3.4




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readBIFF8CellRangeAddressFixed [line 3365]

void _readBIFF8CellRangeAddressFixed( $subData)

Reads a cell range address in BIFF8 e.

Reads a cell range address in BIFF8 e.g. 'A2:B6' or 'A1' always fixed range section 2.5.14




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readBIFF8CellRangeAddressList [line 3429]

void _readBIFF8CellRangeAddressList( $subData)

Read BIFF8 cell range address list

Read BIFF8 cell range address list section 2.5.15




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readBIFF8Constant [line 3522]

void _readBIFF8Constant( $valueData)

read BIFF8 constant value which may be 'Empty Value', 'Number', 'String Value', 'Boolean Value', 'Error Value'

read BIFF8 constant value which may be 'Empty Value', 'Number', 'String Value', 'Boolean Value', 'Error Value' section 2.5.7 returns e.g. array('value' => '5', 'size' => 9)




Tags:

access:  private


Parameters:

   $valueData  

[ Top ]

method _readBIFF8ConstantArray [line 3489]

void _readBIFF8ConstantArray( $arrayData)

read BIFF8 constant value array from array data

read BIFF8 constant value array from array data returns e.g. array('value' => '{1,2;3,4}', 'size' => 40} section 2.5.8




Tags:

access:  private


Parameters:

   $arrayData  

[ Top ]

method _readBlank [line 2501]

void _readBlank( )

Read BLANK record

Read BLANK record




Tags:

access:  private


[ Top ]

method _readBoolErr [line 2355]

void _readBoolErr( )

Read BOOLERR record This record represents a Boolean value or error value cell.

Read BOOLERR record This record represents a Boolean value or error value cell. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readByteStringLong [line 3588]

array _readByteStringLong( $subData)

Read byte string (16-bit string length)

Read byte string (16-bit string length) OpenOffice documentation: 2.5.2




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readByteStringShort [line 3569]

array _readByteStringShort( $subData)

Read byte string (8-bit string length)

Read byte string (8-bit string length) OpenOffice documentation: 2.5.2




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readCodepage [line 1544]

void _readCodepage( )

Read CODEPAGE record

Read CODEPAGE record




Tags:

access:  private


[ Top ]

method _readFont [line 1676]

void _readFont( )

Read a FONT record

Read a FONT record




Tags:

access:  private


[ Top ]

method _readFormat [line 1745]

void _readFormat( )

Read a FORMAT record

Read a FORMAT record




Tags:

access:  private


[ Top ]

method _readFormula [line 2258]

void _readFormula( )

Read FORMULA record This record contains the token array and the result of a formula cell.

Read FORMULA record This record contains the token array and the result of a formula cell. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readHcenter [line 1985]

void _readHcenter( )

Read HCENTER record

Read HCENTER record




Tags:

access:  private


[ Top ]

method _readHorizontalPageBreaks [line 1935]

void _readHorizontalPageBreaks( )

Read HORIZONTALPAGEBREAKS record

Read HORIZONTALPAGEBREAKS record




Tags:

access:  private


[ Top ]

method _readImData [line 2533]

void _readImData( )

Read IMDATA record

Read IMDATA record




Tags:

access:  private


[ Top ]

method _readLabel [line 2458]

void _readLabel( )

Read LABEL record This record represents a cell that contains a string. BIFF8 it is usually replaced by the LABELSST record.

Read LABEL record This record represents a cell that contains a string. In BIFF8 it is usually replaced by the LABELSST record. Excel still uses this record, if it copies unformatted text cells to the clipboard. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readLabelSst [line 2082]

void _readLabelSst( )

Read LABELSST record This record represents a cell that contains a string. replaces the LABEL record and RSTRING record used in BIFF2-BIFF5.

Read LABELSST record This record represents a cell that contains a string. It replaces the LABEL record and RSTRING record used in BIFF2-BIFF5. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readMulBlank [line 2415]

void _readMulBlank( )

Read MULBLANK record

Read MULBLANK record This record represents a cell range of empty cells. All cells are located in the same row -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readMulRk [line 2157]

void _readMulRk( )

Read MULRK record This record represents a cell range containing RK value cells.

Read MULRK record This record represents a cell range containing RK value cells. All cells are located in the same row. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readNumber [line 2213]

void _readNumber( )

Read NUMBER record This record represents a cell that contains a floating-point value.

Read NUMBER record This record represents a cell that contains a floating-point value. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readRk [line 2033]

void _readRk( )

Read RK record This record represents a cell that contains an RK value (encoded integer or floating-point value). floating-point value cannot be encoded to an RK value, a NUMBER record will be written. record INTEGER written in BIFF2.

Read RK record This record represents a cell that contains an RK value (encoded integer or floating-point value). If a floating-point value cannot be encoded to an RK value, a NUMBER record will be written. This record replaces the record INTEGER written in BIFF2. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readSheetRangeByRefIndex [line 3453]

void _readSheetRangeByRefIndex( $index)

Get a sheet range like Sheet1:Sheet3 from REF index

Get a sheet range like Sheet1:Sheet3 from REF index Note: If there is only one sheet in the range, one gets e.g Sheet1




Tags:

access:  private


Parameters:

   $index  

[ Top ]

method _readUnicodeString [line 3649]

array _readUnicodeString( $subData, $characterCount)

Read Unicode string with no string length field, but with known character count

Read Unicode string with no string length field, but with known character count this function is under construction, needs to support rich text, and Asian phonetic settings OpenOffice.org's Documentation of the Microsoft Excel File Format, section 2.5.3




Tags:

access:  private


Parameters:

   $subData  
   $characterCount  

[ Top ]

method _readUnicodeStringLong [line 3627]

void _readUnicodeStringLong( $subData)

Extracts an Excel Unicode long string (16-bit string length)

Extracts an Excel Unicode long string (16-bit string length) OpenOffice documentation: 2.5.3 this function is under construction, needs to support rich text, and Asian phonetic settings




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readUnicodeStringShort [line 3607]

void _readUnicodeStringShort( $subData)

Extracts an Excel Unicode short string (8-bit string length) OpenOffice documentation: 2. function will automatically find out where the Unicode string ends.

Extracts an Excel Unicode short string (8-bit string length) OpenOffice documentation: 2.5.3 function will automatically find out where the Unicode string ends.




Tags:

access:  private


Parameters:

   $subData  

[ Top ]

method _readVcenter [line 2005]

void _readVcenter( )

Read VCENTER record

Read VCENTER record




Tags:

access:  private


[ Top ]

method _readVerticalPageBreaks [line 1960]

void _readVerticalPageBreaks( )

Read VERTICALPAGEBREAKS record

Read VERTICALPAGEBREAKS record




Tags:

access:  private


[ Top ]

method _readXf [line 1769]

void _readXf( )

Read an XF record

Read an XF record




Tags:

access:  private


[ Top ]

method _uncompressByteString [line 3791]

string _uncompressByteString( $string)

Convert UTF-16 string in compressed notation to uncompressed form.

Convert UTF-16 string in compressed notation to uncompressed form. Only used for BIFF8.




Tags:

access:  private


Parameters:

   $string  

[ Top ]

method _UTF8toExcelDoubleQuoted [line 3681]

string _UTF8toExcelDoubleQuoted( $value $value)

Convert UTF-8 string to string surounded by double quotes.

Convert UTF-8 string to string surounded by double quotes. Used for explicit string tokens in formulas. Example: hello"world --> "hello""world"




Tags:

access:  private


Parameters:

$value   $value   string UTF-8 encoded string

[ Top ]


Class Constants

XLS_BIFF7 =  0x0500

[line 92]


[ Top ]

XLS_BIFF8 =  0x0600

[line 91]


[ Top ]

XLS_Type_ARRAY =  0x0221

[line 144]


[ Top ]

XLS_Type_BLANK =  0x0201

[line 137]


[ Top ]

XLS_Type_BOF =  0x0809

[line 148]


[ Top ]

XLS_Type_BOOLERR =  0x0205

[line 140]


[ Top ]

XLS_Type_BOTTOMMARGIN =  0x0029

[line 112]


[ Top ]

XLS_Type_BOUNDSHEET =  0x0085

[line 123]


[ Top ]

XLS_Type_CODEPAGE =  0x0042

[line 116]


[ Top ]

XLS_Type_COLINFO =  0x007d

[line 118]


[ Top ]

XLS_Type_CONTINUE =  0x003c

[line 115]


[ Top ]

XLS_Type_DBCELL =  0x00d7

[line 127]


[ Top ]

XLS_Type_DEFAULTROWHEIGHT =  0x0225

[line 145]


[ Top ]

XLS_Type_DEFCOLWIDTH =  0x0055

[line 117]


[ Top ]

XLS_Type_DIMENSION =  0x0200

[line 136]


[ Top ]

XLS_Type_EOF =  0x000a

[line 98]


[ Top ]

XLS_Type_EXTERNALBOOK =  0x01ae

[line 133]


[ Top ]

XLS_Type_EXTSHEET =  0x0017

[line 103]


[ Top ]

XLS_Type_EXTSST =  0x00ff

[line 132]


[ Top ]

XLS_Type_FILEPASS =  0x002f

[line 113]


[ Top ]

XLS_Type_FONT =  0x0031

[line 114]


[ Top ]

XLS_Type_FOOTER =  0x0015

[line 102]


[ Top ]

XLS_Type_FORMAT =  0x041e

[line 147]


[ Top ]

XLS_Type_FORMULA =  0x0006

[line 97]


[ Top ]

XLS_Type_HCENTER =  0x0083

[line 121]


[ Top ]

XLS_Type_HEADER =  0x0014

[line 101]


[ Top ]

XLS_Type_HORIZONTALPAGEBREAKS =  0x001b

[line 106]


[ Top ]

XLS_Type_HYPERLINK =  0x01b8

[line 135]


[ Top ]

XLS_Type_IMDATA =  0x007f

[line 119]


[ Top ]

XLS_Type_INDEX =  0x020b

[line 143]


[ Top ]

XLS_Type_LABEL =  0x0204

[line 139]


[ Top ]

XLS_Type_LABELSST =  0x00fd

[line 131]


[ Top ]

XLS_Type_LEFTMARGIN =  0x0026

[line 109]


[ Top ]

XLS_Type_MERGEDCELLS =  0x00e5

[line 129]


[ Top ]

XLS_Type_MULBLANK =  0x00be

[line 126]


[ Top ]

XLS_Type_MULRK =  0x00bd

[line 125]


[ Top ]

XLS_Type_NAME =  0x0018

[line 104]


[ Top ]

XLS_Type_NINETEENFOUR =  0x0022

[line 108]


[ Top ]

XLS_Type_NOTE =  0x001c

[line 107]


[ Top ]

XLS_Type_NUMBER =  0x0203

[line 138]


[ Top ]

XLS_Type_PAGESETUP =  0x00a1

[line 124]


[ Top ]

XLS_Type_PASSWORD =  0x0013

[line 100]


[ Top ]

XLS_Type_PROTECT =  0x0012

[line 99]


[ Top ]

XLS_Type_RIGHTMARGIN =  0x0027

[line 110]


[ Top ]

XLS_Type_RK =  0x027e

[line 146]


[ Top ]

XLS_Type_ROW =  0x0208

[line 142]


[ Top ]

XLS_Type_SHEETPR =  0x0081

[line 120]


[ Top ]

XLS_Type_SST =  0x00fc

[line 130]


[ Top ]

XLS_Type_STRING =  0x0207

[line 141]


[ Top ]

XLS_Type_TOPMARGIN =  0x0028

[line 111]


[ Top ]

XLS_Type_TXO =  0x01b6

[line 134]


[ Top ]

XLS_Type_UNKNOWN =  0xffff

[line 149]


[ Top ]

XLS_Type_VCENTER =  0x0084

[line 122]


[ Top ]

XLS_Type_VERTICALPAGEBREAKS =  0x001a

[line 105]


[ Top ]

XLS_Type_XF =  0x00e0

[line 128]


[ Top ]

XLS_WorkbookGlobals =  0x0005

[line 93]


[ Top ]

XLS_Worksheet =  0x0010

[line 94]


[ Top ]



Documentation generated on Mon, 27 Oct 2008 08:38:37 +0100 by phpDocumentor 1.4.1