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

Class: PHPExcel_Reader_Excel5

Source Location: /PHPExcel/Reader/Excel5.php

Class Overview


PHPExcel_Reader_Excel5


Author(s):

Copyright:

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

Implements interfaces:

Variables

Constants

Methods



Class Details

[line 112]
PHPExcel_Reader_Excel5

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




Tags:

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


[ Top ]


Class Variables

$_builtInStyles = array()

[line 289]

Built-in styles

Built-in styles




Tags:

access:  private

Type:   array


[ Top ]

$_codepage =  'CP1252'

[line 261]

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 218]

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 ]

$_dataSize =

[line 225]

Size in bytes of $this->_data

Size in bytes of $this->_data




Tags:

access:  private

Type:   int


[ Top ]

$_definedname = array()

[line 324]

Defined names

Defined names




Tags:

access:  private

Type:   array


[ Top ]

$_drawingData =  ''

[line 366]

The combined MSODRAWING data (per sheet)

The combined MSODRAWING data (per sheet)




Tags:

access:  private

Type:   string


[ Top ]

$_drawingGroupData =  ''

[line 359]

The combined MSODRAWINGGROUP data

The combined MSODRAWINGGROUP data




Tags:

access:  private

Type:   string


[ Top ]

$_externalBooks = array()

[line 310]

External books

External books




Tags:

access:  private

Type:   array


[ Top ]

$_fonts = array()

[line 268]

Shared fonts

Shared fonts




Tags:

access:  private

Type:   array


[ Top ]

$_formats = array()

[line 275]

Shared formats

Shared formats




Tags:

access:  private

Type:   array


[ Top ]

$_frozen =  false

[line 338]

Panes are frozen? (in sheet currently being read).

Panes are frozen? (in sheet currently being read). See WINDOW2 record.




Tags:

access:  private

Type:   boolean


[ Top ]

$_isFitToPages =

[line 345]

Fit printout to number of pages? (in sheet currently being read).

Fit printout to number of pages? (in sheet currently being read). See SHEETPR record.




Tags:

access:  private

Type:   boolean


[ Top ]

$_loadSheetsOnly =  null

[line 197]

Restict which sheets should be loaded?

Restict which sheets should be loaded?




Tags:

access:  private

Type:   array


[ Top ]

$_objs = array()

[line 352]

Objects.

Objects. One OBJ record contributes with one entry.




Tags:

access:  private

Type:   array


[ Top ]

$_ole =

[line 211]

OLE reader

OLE reader




Tags:

access:  private



[ Top ]

$_palette =

[line 296]

Color palette

Color palette




Tags:

access:  private

Type:   array


[ Top ]

$_phpExcel =

[line 239]

Workbook to be returned by the reader.

Workbook to be returned by the reader.




Tags:

access:  private

Type:   PHPExcel


[ Top ]

$_phpSheet =

[line 246]

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 ]

$_pos =

[line 232]

Current position in stream

Current position in stream




Tags:

access:  private

Type:   integer


[ Top ]

$_readDataOnly =  false

[line 190]

Read data only?

Read data only?




Tags:

access:  private

Type:   boolean


[ Top ]

$_readFilter =  null

[line 204]

PHPExcel_Reader_IReadFilter instance

PHPExcel_Reader_IReadFilter instance




Tags:

access:  private



[ Top ]

$_ref = array()

[line 317]

REF structures.

REF structures. Only applies to BIFF8.




Tags:

access:  private

Type:   array


[ Top ]

$_sheets = array()

[line 303]

Worksheets

Worksheets




Tags:

access:  private

Type:   array


[ Top ]

$_sst = array()

[line 331]

Shared strings.

Shared strings. Only applies to BIFF8.




Tags:

access:  private

Type:   array


[ Top ]

$_version =

[line 253]

BIFF version

BIFF version




Tags:

access:  private

Type:   int


[ Top ]

$_xf = array()

[line 282]

Shared styles

Shared styles




Tags:

access:  private

Type:   array


[ Top ]



Class Methods


method canRead [line 448]

boolean canRead( $pFilename, string $pFileName)

Can the current PHPExcel_Reader_IReader read the file?

Can the current PHPExcel_Reader_IReader read the file?




Tags:

access:  public


Parameters:

string   $pFileName  
   $pFilename  

[ Top ]

method getLoadSheetsOnly [line 393]

mixed getLoadSheetsOnly( )

Get which sheets to load

Get which sheets to load




Tags:

access:  public


[ Top ]

method getReadDataOnly [line 373]

boolean getReadDataOnly( )

Read data only?

Read data only?




Tags:

access:  public


[ Top ]

method getReadFilter [line 422]

PHPExcel_Reader_IReadFilter getReadFilter( )

Read filter

Read filter




Tags:

access:  public


[ Top ]

method load [line 475]

void load( string $pFilename)

Loads PHPExcel from file

Loads PHPExcel from file




Tags:

throws:  Exception
access:  public


Parameters:

string   $pFilename  

[ Top ]

method setLoadAllSheets [line 412]

void setLoadAllSheets( )

Set all sheets to load

Set all sheets to load




Tags:

access:  public


[ Top ]

method setLoadSheetsOnly [line 403]

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 383]

void setReadDataOnly( [boolean $pValue = false])

Set read data only

Set read data only




Tags:

access:  public


Parameters:

boolean   $pValue  

[ Top ]

method setReadFilter [line 431]

void setReadFilter( $pValue)

Set read filter

Set read filter




Tags:

access:  public


Parameters:

PHPExcel_Reader_IReadFilter   $pValue  

[ Top ]

constructor __construct [line 438]

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 3437]

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 _decodeCodepage [line 4606]

string _decodeCodepage( string $string)

Convert string to UTF-8.

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




Tags:

access:  private


Parameters:

string   $string  

[ Top ]

method _encodeUTF16 [line 4573]

string _encodeUTF16( string $string, [bool $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   $string  
bool   $compressed  

[ Top ]

method _extractNumber [line 4517]

float _extractNumber( string $data)

Reads first 8 bytes of a string and return IEEE 754 float

Reads first 8 bytes of a string and return IEEE 754 float




Tags:

access:  private


Parameters:

string   $data   Binary string that is at least 8 bytes long

[ Top ]

method _getFormulaFromData [line 3412]

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 3374]

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 4540]

void _GetIEEE754( $rknum)



Tags:

access:  private


Parameters:

   $rknum  

[ Top ]

method _GetInt2d [line 4619]

int _GetInt2d( string $data, int $pos)

Read 16-bit unsigned integer

Read 16-bit unsigned integer




Tags:

access:  private


Parameters:

string   $data  
int   $pos  

[ Top ]

method _GetInt4d [line 4631]

int _GetInt4d( string $data, int $pos)

Read 32-bit signed integer

Read 32-bit signed integer




Tags:

access:  private


Parameters:

string   $data  
int   $pos  

[ Top ]

method _getNextToken [line 3578]

array _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 3335]

array _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 4683]

string _mapBorderStyle( int $index)

Map border style

Map border style OpenOffice documentation: 2.5.11




Tags:

access:  private


Parameters:

int   $index  

[ Top ]

method _mapBuiltInColor [line 4763]

array _mapBuiltInColor( int $color)

Map built-in color to RGB value

Map built-in color to RGB value




Tags:

access:  private


Parameters:

int   $color   Indexed color

[ Top ]

method _mapColor [line 4853]

array _mapColor( int $subData)

Map color array from BIFF8 built-in color index

Map color array from BIFF8 built-in color index




Tags:

access:  private


Parameters:

int   $subData  

[ Top ]

method _mapColorBIFF5 [line 4784]

array _mapColorBIFF5( int $subData)

Map color array from BIFF5 built-in color index

Map color array from BIFF5 built-in color index




Tags:

access:  private


Parameters:

int   $subData  

[ Top ]

method _mapErrorCode [line 4743]

string _mapErrorCode( int $subData)

Map error code, e.

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




Tags:

access:  private


Parameters:

int   $subData  

[ Top ]

method _mapFillPattern [line 4711]

string _mapFillPattern( int $index)

Get fill pattern from index

Get fill pattern from index OpenOffice documentation: 2.5.12




Tags:

access:  private


Parameters:

int   $index  

[ Top ]

method _readBIFF8CellAddress [line 4086]

string _readBIFF8CellAddress( string $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:

string   $cellAddressStructure  

[ Top ]

method _readBIFF8CellRangeAddress [line 4144]

string _readBIFF8CellRangeAddress( string $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:

string   $subData  

[ Top ]

method _readBIFF8CellRangeAddressFixed [line 4116]

string _readBIFF8CellRangeAddressFixed( string $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:

string   $subData  

[ Top ]

method _readBIFF8CellRangeAddressList [line 4195]

array _readBIFF8CellRangeAddressList( string $subData)

Read BIFF8 cell range address list

Read BIFF8 cell range address list section 2.5.15




Tags:

access:  private


Parameters:

string   $subData  

[ Top ]

method _readBIFF8Constant [line 4309]

array _readBIFF8Constant( string $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:

string   $valueData  

[ Top ]

method _readBIFF8ConstantArray [line 4271]

array _readBIFF8ConstantArray( string $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:

string   $arrayData  

[ Top ]

method _readBlank [line 2864]

void _readBlank( )

Read BLANK record

Read BLANK record




Tags:

access:  private


[ Top ]

method _readBoolErr [line 2725]

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 _readBottomMargin [line 2148]

void _readBottomMargin( )

Read BOTTOMMARGIN record

Read BOTTOMMARGIN record




Tags:

access:  private


[ Top ]

method _readByteStringLong [line 4403]

array _readByteStringLong( string $subData)

Read byte string (16-bit string length)

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




Tags:

access:  private


Parameters:

string   $subData  

[ Top ]

method _readByteStringShort [line 4382]

array _readByteStringShort( string $subData)

Read byte string (8-bit string length)

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




Tags:

access:  private


Parameters:

string   $subData  

[ Top ]

method _readCodepage [line 925]

void _readCodepage( )

CODEPAGE This record stores the text encoding used to write byte strings, stored as MS Windows code page identifier.

CODEPAGE This record stores the text encoding used to write byte strings, stored as MS Windows code page identifier. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readColInfo [line 2283]

void _readColInfo( )

Read COLINFO record

Read COLINFO record




Tags:

access:  private


[ Top ]

method _readColor [line 4654]

array _readColor( int $color)

Read color

Read color




Tags:

return:  RGB color value, example: array('rgb' => 'FF0000')
access:  private


Parameters:

int   $color   Indexed color

[ Top ]

method _readContinue [line 3294]

void _readContinue( )

Read a free CONTINUE record. When MSODRAWING data on a sheet exceeds 8224 bytes, CONTINUE records are used instead.

Read a free CONTINUE record. Free CONTINUE record may be a camouflaged MSODRAWING record When MSODRAWING data on a sheet exceeds 8224 bytes, CONTINUE records are used instead. Undocumented. In this case, we must treat the CONTINUE record as a MSODRAWING record




Tags:

access:  private


[ Top ]

method _readDateMode [line 1105]

void _readDateMode( )

DATEMODE This record specifies the base date for displaying date values. base date. Calculation Settings Block. stored in the Workbook Globals Substream.

DATEMODE This record specifies the base date for displaying date values. All dates are stored as count of days past this base date. In BIFF2-BIFF4 this record is part of the Calculation Settings Block. In BIFF5-BIFF8 it is stored in the Workbook Globals Substream. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readDefault [line 885]

void _readDefault( )

Reads a general type of BIFF record.

Reads a general type of BIFF record. Does nothing except for moving stream pointer forward to next record.




Tags:

access:  private


[ Top ]

method _readDefaultRowHeight [line 1917]

void _readDefaultRowHeight( )

Read DEFAULTROWHEIGHT record

Read DEFAULTROWHEIGHT record




Tags:

access:  private


[ Top ]

method _readDefColWidth [line 2265]

void _readDefColWidth( )

Read DEFCOLWIDTH record

Read DEFCOLWIDTH record




Tags:

access:  private


[ Top ]

method _readDefinedName [line 1647]

void _readDefinedName( )

DEFINEDNAME This record is part of a Link Table. and the token array of an internal defined name. arrays of defined names contain tokens with aberrant token classes.

DEFINEDNAME This record is part of a Link Table. It contains the name and the token array of an internal defined name. Token arrays of defined names contain tokens with aberrant token classes. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readExternalBook [line 1548]

void _readExternalBook( )

Read EXTERNALBOOK record

Read EXTERNALBOOK record




Tags:

access:  private


[ Top ]

method _readExternSheet [line 1611]

void _readExternSheet( )

Read EXTERNSHEET record

Read EXTERNSHEET record




Tags:

access:  private


[ Top ]

method _readFilepass [line 905]

void _readFilepass( )

FILEPASS This record is part of the File Protection Block. contains information about the read/write password of the file. encrypted.

FILEPASS This record is part of the File Protection Block. It contains information about the read/write password of the file. All record contents following this record will be encrypted. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readFont [line 1123]

void _readFont( )

Read a FONT record

Read a FONT record




Tags:

access:  private


[ Top ]

method _readFooter [line 2037]

void _readFooter( )

Read FOOTER record

Read FOOTER record




Tags:

access:  private


[ Top ]

method _readFormat [line 1204]

void _readFormat( )

FORMAT This record contains information about a number format.

FORMAT This record contains information about a number format. All FORMAT records occur together in a sequential list. In BIFF2-BIFF4 other records referencing a FORMAT record contain a zero-based index into this list. From BIFF5 on the FORMAT record contains the index itself that will be used by other records. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readFormula [line 2603]

void _readFormula( )

Read FORMULA record + perhaps a following STRING record if formula result is a string This record contains the token array and the result of a formula cell.

Read FORMULA record + perhaps a following STRING record if formula result is a string 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 2059]

void _readHcenter( )

Read HCENTER record

Read HCENTER record




Tags:

access:  private


[ Top ]

method _readHeader [line 2015]

void _readHeader( )

Read HEADER record

Read HEADER record




Tags:

access:  private


[ Top ]

method _readHorizontalPageBreaks [line 1960]

void _readHorizontalPageBreaks( )

Read HORIZONTALPAGEBREAKS record

Read HORIZONTALPAGEBREAKS record




Tags:

access:  private


[ Top ]

method _readHyperLink [line 3038]

void _readHyperLink( )

Read HYPERLINK record

Read HYPERLINK record




Tags:

access:  private


[ Top ]

method _readImData [line 3212]

void _readImData( )

Read IMDATA record

Read IMDATA record




Tags:

access:  private


[ Top ]

method _readLabel [line 2823]

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 2437]

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 _readLeftMargin [line 2097]

void _readLeftMargin( )

Read LEFTMARGIN record

Read LEFTMARGIN record




Tags:

access:  private


[ Top ]

method _readMergedCells [line 3019]

void _readMergedCells( )

MERGEDCELLS This record contains the addresses of merged cell ranges in the current sheet.

MERGEDCELLS This record contains the addresses of merged cell ranges in the current sheet. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readMsoDrawing [line 2895]

void _readMsoDrawing( )

Read MSODRAWING record

Read MSODRAWING record




Tags:

access:  private


[ Top ]

method _readMsoDrawingGroup [line 1696]

void _readMsoDrawingGroup( )

Read MSODRAWINGGROUP record

Read MSODRAWINGGROUP record




Tags:

access:  private


[ Top ]

method _readMulBlank [line 2782]

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 2510]

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 2563]

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 _readObj [line 2909]

void _readObj( )

Read OBJ record

Read OBJ record




Tags:

access:  private


[ Top ]

method _readPageSetup [line 2165]

void _readPageSetup( )

Read PAGESETUP record

Read PAGESETUP record




Tags:

access:  private


[ Top ]

method _readPalette [line 1482]

void _readPalette( )

Read PALETTE record

Read PALETTE record




Tags:

access:  private


[ Top ]

method _readPane [line 2986]

void _readPane( )

Read PANE record

Read PANE record




Tags:

access:  private


[ Top ]

method _readPassword [line 2247]

void _readPassword( )

PASSWORD - Sheet protection (hashed) password (BIFF2 through BIFF8)

PASSWORD - Sheet protection (hashed) password (BIFF2 through BIFF8)




Tags:

access:  private


[ Top ]

method _readPrintGridlines [line 1899]

void _readPrintGridlines( )

Read PRINTGRIDLINES record

Read PRINTGRIDLINES record




Tags:

access:  private


[ Top ]

method _readProtect [line 2224]

void _readProtect( )

PROTECT - Sheet protection (BIFF2 through BIFF8)

PROTECT - Sheet protection (BIFF2 through BIFF8) if this record is omitted, then it also means no sheet protection




Tags:

access:  private


[ Top ]

method _readRangeProtection [line 3156]

void _readRangeProtection( )

Read RANGEPROTECTION record

Read RANGEPROTECTION record Reading of this record is based on Microsoft Office Excel 97-2000 Binary File Format Specification, where it is referred to as FEAT record




Tags:

access:  private


[ Top ]

method _readRGB [line 4358]

array _readRGB( string $rgb)

Extract RGB color

Extract RGB color OpenOffice.org's Documentation of the Microsoft Excel File Format, section 2.5.4




Tags:

access:  private


Parameters:

string   $rgb   Encoded RGB value (4 bytes)

[ Top ]

method _readRightMargin [line 2114]

void _readRightMargin( )

Read RIGHTMARGIN record

Read RIGHTMARGIN record




Tags:

access:  private


[ Top ]

method _readRk [line 2394]

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 _readRow [line 2335]

void _readRow( )

ROW This record contains the properties of a single row in a sheet. of 32 rows.

ROW This record contains the properties of a single row in a sheet. Rows and cells in a sheet are divided into blocks of 32 rows. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readScl [line 2965]

void _readScl( )

Read SCL record

Read SCL record




Tags:

access:  private


[ Top ]

method _readSheet [line 1514]

void _readSheet( )

SHEET This record is located in the Workbook Globals Substream and represents a sheet inside the workbook.

SHEET This record is located in the Workbook Globals Substream and represents a sheet inside the workbook. One SHEET record is written for each sheet. It stores the sheet name and a stream offset to the BOF record of the respective Sheet Substream within the Workbook Stream. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readSheetPr [line 1934]

void _readSheetPr( )

Read SHEETPR record

Read SHEETPR record




Tags:

access:  private


[ Top ]

method _readSheetRangeByRefIndex [line 4225]

string|false _readSheetRangeByRefIndex( int $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 It can also happen that the REF structure uses the -1 (FFFF) code to indicate deleted sheets, in which case an exception is thrown




Tags:

throws:  Exception
access:  private


Parameters:

int   $index  

[ Top ]

method _readSst [line 1718]

void _readSst( )

SST - Shared String Table This record contains a list of all strings used anywhere in the workbook. workbook uses indexes into the list to reference the strings.

SST - Shared String Table This record contains a list of all strings used anywhere in the workbook. Each string occurs only once. The workbook uses indexes into the list to reference the strings. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _readString [line 2698]

string _readString( )

Read a STRING record from current stream position and advance the stream pointer to next record

Read a STRING record from current stream position and advance the stream pointer to next record This record is used for storing result from FORMULA record when it is a string, and it occurs directly after the FORMULA record




Tags:

return:  The string contents as UTF-8
access:  private


[ Top ]

method _readStyle [line 1449]

void _readStyle( )

Read STYLE record

Read STYLE record




Tags:

access:  private


[ Top ]

method _readTopMargin [line 2131]

void _readTopMargin( )

Read TOPMARGIN record

Read TOPMARGIN record




Tags:

access:  private


[ Top ]

method _readUnicodeString [line 4473]

array _readUnicodeString( string $subData, int $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:

string   $subData  
int   $characterCount  

[ Top ]

method _readUnicodeStringLong [line 4449]

array _readUnicodeStringLong( string $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:

string   $subData  

[ Top ]

method _readUnicodeStringShort [line 4426]

array _readUnicodeStringShort( string $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:

string   $subData  

[ Top ]

method _readVcenter [line 2078]

void _readVcenter( )

Read VCENTER record

Read VCENTER record




Tags:

access:  private


[ Top ]

method _readVerticalPageBreaks [line 1988]

void _readVerticalPageBreaks( )

Read VERTICALPAGEBREAKS record

Read VERTICALPAGEBREAKS record




Tags:

access:  private


[ Top ]

method _readWindow2 [line 2937]

void _readWindow2( )

Read WINDOW2 record

Read WINDOW2 record




Tags:

access:  private


[ Top ]

method _readXf [line 1236]

void _readXf( )

XF - Extended Format This record contains formatting information for cells, rows, columns or styles.

XF - Extended Format This record contains formatting information for cells, rows, columns or styles. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"




Tags:

access:  private


[ Top ]

method _uncompressByteString [line 4590]

string _uncompressByteString( string $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   $string  

[ Top ]

method _UTF8toExcelDoubleQuoted [line 4506]

string _UTF8toExcelDoubleQuoted( string $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:

string   $value   UTF-8 encoded string

[ Top ]


Class Constants

XLS_BIFF7 =  0x0500

[line 116]


[ Top ]

XLS_BIFF8 =  0x0600

[line 115]


[ Top ]

XLS_Type_ARRAY =  0x0221

[line 175]


[ Top ]

XLS_Type_BLANK =  0x0201

[line 168]


[ Top ]

XLS_Type_BOF =  0x0809

[line 181]


[ Top ]

XLS_Type_BOOLERR =  0x0205

[line 171]


[ Top ]

XLS_Type_BOTTOMMARGIN =  0x0029

[line 136]


[ Top ]

XLS_Type_CODEPAGE =  0x0042

[line 142]


[ Top ]

XLS_Type_COLINFO =  0x007d

[line 145]


[ Top ]

XLS_Type_CONTINUE =  0x003c

[line 140]


[ Top ]

XLS_Type_DATEMODE =  0x0022

[line 132]


[ Top ]

XLS_Type_DBCELL =  0x00d7

[line 156]


[ Top ]

XLS_Type_DEFAULTROWHEIGHT =  0x0225

[line 176]


[ Top ]

XLS_Type_DEFCOLWIDTH =  0x0055

[line 143]


[ Top ]

XLS_Type_DEFINEDNAME =  0x0018

[line 128]


[ Top ]

XLS_Type_DIMENSION =  0x0200

[line 167]


[ Top ]

XLS_Type_EOF =  0x000a

[line 122]


[ Top ]

XLS_Type_EXTERNALBOOK =  0x01ae

[line 164]


[ Top ]

XLS_Type_EXTERNSHEET =  0x0017

[line 127]


[ Top ]

XLS_Type_EXTSST =  0x00ff

[line 163]


[ Top ]

XLS_Type_FILEPASS =  0x002f

[line 138]


[ Top ]

XLS_Type_FONT =  0x0031

[line 139]


[ Top ]

XLS_Type_FOOTER =  0x0015

[line 126]


[ Top ]

XLS_Type_FORMAT =  0x041e

[line 180]


[ Top ]

XLS_Type_FORMULA =  0x0006

[line 121]


[ Top ]

XLS_Type_HCENTER =  0x0083

[line 148]


[ Top ]

XLS_Type_HEADER =  0x0014

[line 125]


[ Top ]

XLS_Type_HORIZONTALPAGEBREAKS =  0x001b

[line 130]


[ Top ]

XLS_Type_HYPERLINK =  0x01b8

[line 166]


[ Top ]

XLS_Type_IMDATA =  0x007f

[line 146]


[ Top ]

XLS_Type_INDEX =  0x020b

[line 174]


[ Top ]

XLS_Type_LABEL =  0x0204

[line 170]


[ Top ]

XLS_Type_LABELSST =  0x00fd

[line 162]


[ Top ]

XLS_Type_LEFTMARGIN =  0x0026

[line 133]


[ Top ]

XLS_Type_MERGEDCELLS =  0x00e5

[line 158]


[ Top ]

XLS_Type_MSODRAWING =  0x00ec

[line 160]


[ Top ]

XLS_Type_MSODRAWINGGROUP =  0x00eb

[line 159]


[ Top ]

XLS_Type_MULBLANK =  0x00be

[line 155]


[ Top ]

XLS_Type_MULRK =  0x00bd

[line 154]


[ Top ]

XLS_Type_NOTE =  0x001c

[line 131]


[ Top ]

XLS_Type_NUMBER =  0x0203

[line 169]


[ Top ]

XLS_Type_OBJ =  0x005d

[line 144]


[ Top ]

XLS_Type_PAGESETUP =  0x00a1

[line 153]


[ Top ]

XLS_Type_PALETTE =  0x0092

[line 151]


[ Top ]

XLS_Type_PANE =  0x0041

[line 141]


[ Top ]

XLS_Type_PASSWORD =  0x0013

[line 124]


[ Top ]

XLS_Type_PRINTGRIDLINES =  0x002b

[line 137]


[ Top ]

XLS_Type_PROTECT =  0x0012

[line 123]


[ Top ]

XLS_Type_RANGEPROTECTION =  0x0868

[line 182]


[ Top ]

XLS_Type_RIGHTMARGIN =  0x0027

[line 134]


[ Top ]

XLS_Type_RK =  0x027e

[line 178]


[ Top ]

XLS_Type_ROW =  0x0208

[line 173]


[ Top ]

XLS_Type_SCL =  0x00a0

[line 152]


[ Top ]

XLS_Type_SHEET =  0x0085

[line 150]


[ Top ]

XLS_Type_SHEETPR =  0x0081

[line 147]


[ Top ]

XLS_Type_SST =  0x00fc

[line 161]


[ Top ]

XLS_Type_STRING =  0x0207

[line 172]


[ Top ]

XLS_Type_STYLE =  0x0293

[line 179]


[ Top ]

XLS_Type_TOPMARGIN =  0x0028

[line 135]


[ Top ]

XLS_Type_TXO =  0x01b6

[line 165]


[ Top ]

XLS_Type_UNKNOWN =  0xffff

[line 183]


[ Top ]

XLS_Type_VCENTER =  0x0084

[line 149]


[ Top ]

XLS_Type_VERTICALPAGEBREAKS =  0x001a

[line 129]


[ Top ]

XLS_Type_WINDOW2 =  0x023e

[line 177]


[ Top ]

XLS_Type_XF =  0x00e0

[line 157]


[ Top ]

XLS_WorkbookGlobals =  0x0005

[line 117]


[ Top ]

XLS_Worksheet =  0x0010

[line 118]


[ Top ]



Documentation generated on Wed, 22 Apr 2009 08:57:56 +0200 by phpDocumentor 1.4.1