Docs For Class PHPExcel_Reader

$_codepage =

[line 270]

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

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

Size in bytes of $this->_data

Tags:

access:

private

Type:

int

[ Top ]

$_definedname =

[line 319]

Defined names

Tags:

access:

private

Type:

array

[ Top ]

$_drawingData =

[line 361]

The combined MSODRAWING data (per sheet)

Tags:

access:

private

Type:

string

[ Top ]

$_drawingGroupData =

[line 354]

The combined MSODRAWINGGROUP data

Tags:

access:

private

Type:

string

[ Top ]

$_externalBooks =

[line 305]

External books

Tags:

access:

private

Type:

array

[ Top ]

$_formats =

[line 277]

Shared formats

Tags:

access:

private

Type:

array

[ Top ]

$_frozen =

[line 333]

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

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

Restict which sheets should be loaded?

Tags:

access:

private

Type:

array

[ Top ]

$_mapCellStyleXfIndex =

[line 382]

Mapping of XF index (that is a style XF) to final index in cellStyleXf collection

Tags:

access:

private

Type:

array

[ Top ]

$_mapCellXfIndex =

[line 375]

Mapping of XF index (that is a cell XF) to final index in cellXf collection

Tags:

access:

private

Type:

array

[ Top ]

$_objFonts =

[line 284]

Shared fonts

Tags:

access:

private

Type:

array

[ Top ]

$_objs =

[line 347]

Objects.

Objects. One OBJ record contributes with one entry.

Tags:

access:

private

Type:

array

[ Top ]

$_ole =

[line 220]

OLE reader

Tags:

access:

private

Type:

PHPExcel_Shared_OLERead

[ Top ]

$_palette =

[line 291]

Color palette

Tags:

access:

private

Type:

array

[ Top ]

$_phpExcel =

[line 248]

Workbook to be returned by the reader.

Tags:

access:

private

Type:

PHPExcel

[ Top ]

$_phpSheet =

[line 255]

Worksheet that is currently being built by the reader.

Tags:

access:

private

Type:

PHPExcel_Worksheet

[ Top ]

$_pos =

[line 241]

Current position in stream

Tags:

access:

private

Type:

integer

[ Top ]

$_readDataOnly = false

[line 199]

Read data only?

Tags:

access:

private

Type:

boolean

[ Top ]

$_readFilter = null

[line 213]

PHPExcel_Reader_IReadFilter instance

Tags:

access:

private

Type:

PHPExcel_Reader_IReadFilter

[ Top ]

$_ref =

[line 312]

REF structures.

REF structures. Only applies to BIFF8.

Tags:

access:

private

Type:

array

[ Top ]

$_sharedFormulaParts =

[line 397]

The shared formula parts in a sheet. refers to a shared formula.

The shared formula parts in a sheet. One FORMULA record contributes with one value if it refers to a shared formula.

Tags:

access:

private

Type:

array

[ Top ]

$_sharedFormulas =

[line 389]

The shared formulas in a sheet.

The shared formulas in a sheet. One SHAREDFMLA record contributes with one value.

Tags:

access:

private

Type:

array

[ Top ]

$_sheets =

[line 298]

Worksheets

Tags:

access:

private

Type:

array

[ Top ]

$_sst =

[line 326]

Shared strings.

Shared strings. Only applies to BIFF8.

Tags:

access:

private

Type:

array

[ Top ]

$_version =

[line 262]

BIFF version

Tags:

access:

private

Type:

int

[ Top ]

$_xfIndex =

[line 368]

Keep track of XF index

Tags:

access:

private

Type:

int

[ Top ]

Class Methods

method canRead [line 488]

boolean canRead(

$pFilename, string
$pFileName)

Can the current PHPExcel_Reader_IReader read the file?

Tags:

access:

public

Parameters:

string	$pFileName
	$pFilename

[ Top ]

method getLoadSheetsOnly [line 426]

mixed getLoadSheetsOnly(
)

Get which sheets to load

Tags:

access:

public

[ Top ]

method getReadDataOnly [line 404]

boolean getReadDataOnly(
)

Read data only?

Tags:

access:

public

[ Top ]

method getReadFilter [line 460]

PHPExcel_Reader_IReadFilter getReadFilter(
)

Read filter

Tags:

access:

public

[ Top ]

method load [line 514]

void load(
string
$pFilename)

Loads PHPExcel from file

Tags:

throws:	Exception
access:	public

Parameters:

string

$pFilename

[ Top ]

method setLoadAllSheets [line 449]

PHPExcel_Reader_Excel5 setLoadAllSheets(
)

Set all sheets to load

Tags:

access:

public

[ Top ]

method setLoadSheetsOnly [line 437]

PHPExcel_Reader_Excel5 setLoadSheetsOnly(
[mixed
$value = null])

Set which sheets to load

Tags:

access:

public

Parameters:

mixed

$value

[ Top ]

method setReadDataOnly [line 415]

PHPExcel_Reader_Excel5 setReadDataOnly(
[boolean
$pValue = false])

Set read data only

Tags:

access:

public

Parameters:

boolean

$pValue

[ Top ]

method setReadFilter [line 470]

PHPExcel_Reader_Excel5 setReadFilter(

$pValue)

Set read filter

Tags:

access:

public

Parameters:

PHPExcel_Reader_IReadFilter

$pValue

[ Top ]

constructor __construct [line 478]

PHPExcel_Reader_Excel5 __construct(
)

Create a new PHPExcel_Reader_Excel5 instance

Tags:

access:

public

[ Top ]

method _createFormulaFromTokens [line 3650]

string _createFormulaFromTokens(
array
$tokens, array
$additionalData, string
$baseCell)

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
string	$baseCell	Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas

[ Top ]

method _decodeCodepage [line 4934]

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

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

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

Tags:

access:

private

Parameters:

string	$string
bool	$compressed

[ Top ]

method _extractNumber [line 4845]

float _extractNumber(
string
$data)

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

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

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
string	$baseCell	Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas

[ Top ]

method _getFormulaFromStructure [line 3585]

string _getFormulaFromStructure(
string
$formulaStructure, [string
$baseCell = 'A1'])

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
string	$baseCell	Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas

[ Top ]

method _GetIEEE754 [line 4868]

void _GetIEEE754(

$rknum)

Tags:

access:

private

Parameters:

$rknum

[ Top ]

method _GetInt2d [line 4947]

int _GetInt2d(
string
$data, int
$pos)

Read 16-bit unsigned integer

Tags:

access:

private

Parameters:

string	$data
int	$pos

[ Top ]

method _GetInt4d [line 4959]

int _GetInt4d(
string
$data, int
$pos)

Read 32-bit signed integer

Tags:

access:

private

Parameters:

string	$data
int	$pos

[ Top ]

method _getNextToken [line 3798]

array _getNextToken(
string
$formulaData, [string
$baseCell = 'A1'])

Fetch next token from binary formula data

Tags:

throws:	Exception
access:	private

Parameters:

string	$baseCell	Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
string	$formulaData	Formula data

[ Top ]

method _getSplicedRecordData [line 3545]

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

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

array _mapBuiltInColor(
int
$color)

Map built-in color to RGB value

Tags:

access:

private

Parameters:

int

$color

Indexed color

[ Top ]

method _mapColor [line 5183]

array _mapColor(
int
$subData)

Map color array from BIFF8 built-in color index

Tags:

access:

private

Parameters:

int

$subData

[ Top ]

method _mapColorBIFF5 [line 5114]

array _mapColorBIFF5(
int
$subData)

Map color array from BIFF5 built-in color index

Tags:

access:

private

Parameters:

int

$subData

[ Top ]

method _mapErrorCode [line 5071]

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

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 _readBIFF5CellRangeAddressFixed [line 4388]

string _readBIFF5CellRangeAddressFixed(
string
$subData)

Reads a cell range address in BIFF5 e.

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

Tags:

throws:	Exception
access:	private

Parameters:

string

$subData

[ Top ]

method _readBIFF8CellAddress [line 4314]

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 _readBIFF8CellAddressB [line 4345]

string _readBIFF8CellAddressB(
string
$cellAddressStructure, [string
$baseCell = 'A1'])

Reads a cell address in BIFF8 for shared formulas.

Reads a cell address in BIFF8 for shared formulas. Uses positive and negative values for row and column to indicate offsets from a base cell section 3.3.4

Tags:

access:

private

Parameters:

string	$cellAddressStructure
string	$baseCell	Base cell, only needed when formula contains tRefN tokens, e.g. with shared formulas

[ Top ]

method _readBIFF8CellRangeAddress [line 4463]

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

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:

throws:	Exception
access:	private

Parameters:

string

$subData

[ Top ]

method _readBIFF8CellRangeAddressList [line 4514]

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

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

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

void _readBlank(
)

Read BLANK record

Tags:

access:

private

[ Top ]

method _readBoolErr [line 2924]

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

void _readBottomMargin(
)

Read BOTTOMMARGIN record

Tags:

access:

private

[ Top ]

method _readByteStringLong [line 4731]

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

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

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

void _readColInfo(
)

Read COLINFO record

Tags:

access:

private

[ Top ]

method _readColor [line 4982]

array _readColor(
int
$color)

Read color

Tags:

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

Parameters:

int

$color

Indexed color

[ Top ]

method _readContinue [line 3504]

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

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

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

void _readDefaultRowHeight(
)

Read DEFAULTROWHEIGHT record

Tags:

access:

private

[ Top ]

method _readDefColWidth [line 2386]

void _readDefColWidth(
)

Read DEFCOLWIDTH record

Tags:

access:

private

[ Top ]

method _readDefinedName [line 1759]

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

void _readExternalBook(
)

Read EXTERNALBOOK record

Tags:

access:

private

[ Top ]

method _readExternSheet [line 1723]

void _readExternSheet(
)

Read EXTERNSHEET record

Tags:

access:

private

[ Top ]

method _readFilepass [line 948]

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

void _readFont(
)

Read a FONT record

Tags:

access:

private

[ Top ]

method _readFooter [line 2154]

void _readFooter(
)

Read FOOTER record

Tags:

access:

private

[ Top ]

method _readFormat [line 1261]

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

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

void _readHcenter(
)

Read HCENTER record

Tags:

access:

private

[ Top ]

method _readHeader [line 2127]

void _readHeader(
)

Read HEADER record

Tags:

access:

private

[ Top ]

method _readHorizontalPageBreaks [line 2072]

void _readHorizontalPageBreaks(
)

Read HORIZONTALPAGEBREAKS record

Tags:

access:

private

[ Top ]

method _readHyperLink [line 3240]

void _readHyperLink(
)

Read HYPERLINK record

Tags:

access:

private

[ Top ]

method _readImData [line 3422]

void _readImData(
)

Read IMDATA record

Tags:

access:

private

[ Top ]

method _readLabel [line 3022]

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

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

void _readLeftMargin(
)

Read LEFTMARGIN record

Tags:

access:

private

[ Top ]

method _readMergedCells [line 3221]

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

void _readMsoDrawing(
)

Read MSODRAWING record

Tags:

access:

private

[ Top ]

method _readMsoDrawingGroup [line 1808]

void _readMsoDrawingGroup(
)

Read MSODRAWINGGROUP record

Tags:

access:

private

[ Top ]

method _readMulBlank [line 2981]

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

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

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

void _readObj(
)

Read OBJ record

Tags:

access:

private

[ Top ]

method _readPageSetup [line 2286]

void _readPageSetup(
)

Read PAGESETUP record

Tags:

access:

private

[ Top ]

method _readPalette [line 1594]

void _readPalette(
)

Read PALETTE record

Tags:

access:

private

[ Top ]

method _readPane [line 3188]

void _readPane(
)

Read PANE record

Tags:

access:

private

[ Top ]

method _readPassword [line 2368]

void _readPassword(
)

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

Tags:

access:

private

[ Top ]

method _readPrintGridlines [line 2011]

void _readPrintGridlines(
)

Read PRINTGRIDLINES record

Tags:

access:

private

[ Top ]

method _readProtect [line 2345]

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

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

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

void _readRightMargin(
)

Read RIGHTMARGIN record

Tags:

access:

private

[ Top ]

method _readRk [line 2526]

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

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

void _readScl(
)

Read SCL record

Tags:

access:

private

[ Top ]

method _readSharedFmla [line 2865]

void _readSharedFmla(
)

Read a SHAREDFMLA record. which usually contains relative references.

Read a SHAREDFMLA record. This function just stores the binary shared formula in the reader, which usually contains relative references. These will be used to construct the formula in each shared formula part after the sheet is read.

Tags:

access:

private

[ Top ]

method _readSheet [line 1626]

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

void _readSheetPr(
)

Read SHEETPR record

Tags:

access:

private

[ Top ]

method _readSheetRangeByRefIndex [line 4544]

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

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

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

void _readStyle(
)

Read STYLE record

Tags:

access:

private

[ Top ]

method _readTopMargin [line 2252]

void _readTopMargin(
)

Read TOPMARGIN record

Tags:

access:

private

[ Top ]

method _readUnicodeString [line 4801]

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

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

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

void _readVcenter(
)

Read VCENTER record

Tags:

access:

private

[ Top ]

method _readVerticalPageBreaks [line 2100]

void _readVerticalPageBreaks(
)

Read VERTICALPAGEBREAKS record

Tags:

access:

private

[ Top ]

method _readWindow2 [line 3136]

void _readWindow2(
)

Read WINDOW2 record

Tags:

access:

private

[ Top ]

method _readXf [line 1298]

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. According to http://support.microsoft.com/kb/147732 there are always at least 15 cell style XF and 1 cell XF. Inspection of Excel files generated by MS Office Excel shows that XF records 0-14 are cell style XF and XF record 15 is a cell XF We only read the first cell style XF and skip the remaining cell style XF records We read all cell XF records. -- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

Tags:

access:

private

[ Top ]

method _uncompressByteString [line 4918]

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

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

[ Top ]

XLS_BIFF8 = 0x0600

[line 123]

[ Top ]

XLS_Type_ARRAY = 0x0221

[line 183]

[ Top ]

XLS_Type_BLANK = 0x0201

[line 176]

[ Top ]

XLS_Type_BOF = 0x0809

[line 190]

[ Top ]

XLS_Type_BOOLERR = 0x0205

[line 179]

[ Top ]

XLS_Type_BOTTOMMARGIN = 0x0029

[line 144]

[ Top ]

XLS_Type_CODEPAGE = 0x0042

[line 150]

[ Top ]

XLS_Type_COLINFO = 0x007d

[line 153]

[ Top ]

XLS_Type_CONTINUE = 0x003c

[line 148]

[ Top ]

XLS_Type_DATEMODE = 0x0022

[line 140]

[ Top ]

XLS_Type_DBCELL = 0x00d7

[line 164]

[ Top ]

XLS_Type_DEFAULTROWHEIGHT = 0x0225

[line 184]

[ Top ]

XLS_Type_DEFCOLWIDTH = 0x0055

[line 151]

[ Top ]

XLS_Type_DEFINEDNAME = 0x0018

[line 136]

[ Top ]

XLS_Type_DIMENSION = 0x0200

[line 175]

[ Top ]

XLS_Type_EOF = 0x000a

[line 130]

[ Top ]

XLS_Type_EXTERNALBOOK = 0x01ae

[line 172]

[ Top ]

XLS_Type_EXTERNSHEET = 0x0017

[line 135]

[ Top ]

XLS_Type_EXTSST = 0x00ff

[line 171]

[ Top ]

XLS_Type_FILEPASS = 0x002f

[line 146]

[ Top ]

XLS_Type_FONT = 0x0031

[line 147]

[ Top ]

XLS_Type_FOOTER = 0x0015

[line 134]

[ Top ]

XLS_Type_FORMAT = 0x041e

[line 188]

[ Top ]

XLS_Type_FORMULA = 0x0006

[line 129]

[ Top ]

XLS_Type_HCENTER = 0x0083

[line 156]

[ Top ]

XLS_Type_HEADER = 0x0014

[line 133]

[ Top ]

XLS_Type_HORIZONTALPAGEBREAKS = 0x001b

[line 138]

[ Top ]

XLS_Type_HYPERLINK = 0x01b8

[line 174]

[ Top ]

XLS_Type_IMDATA = 0x007f

[line 154]

[ Top ]

XLS_Type_INDEX = 0x020b

[line 182]

[ Top ]

XLS_Type_LABEL = 0x0204

[line 178]

[ Top ]

XLS_Type_LABELSST = 0x00fd

[line 170]

[ Top ]

XLS_Type_LEFTMARGIN = 0x0026

[line 141]

[ Top ]

XLS_Type_MERGEDCELLS = 0x00e5

[line 166]

[ Top ]

XLS_Type_MSODRAWING = 0x00ec

[line 168]

[ Top ]

XLS_Type_MSODRAWINGGROUP = 0x00eb

[line 167]

[ Top ]

XLS_Type_MULBLANK = 0x00be

[line 163]

[ Top ]

XLS_Type_MULRK = 0x00bd

[line 162]

[ Top ]

XLS_Type_NOTE = 0x001c

[line 139]

[ Top ]

XLS_Type_NUMBER = 0x0203

[line 177]

[ Top ]

XLS_Type_OBJ = 0x005d

[line 152]

[ Top ]

XLS_Type_PAGESETUP = 0x00a1

[line 161]

[ Top ]

XLS_Type_PALETTE = 0x0092

[line 159]

[ Top ]

XLS_Type_PANE = 0x0041

[line 149]

[ Top ]

XLS_Type_PASSWORD = 0x0013

[line 132]

[ Top ]

XLS_Type_PRINTGRIDLINES = 0x002b

[line 145]

[ Top ]

XLS_Type_PROTECT = 0x0012

[line 131]

[ Top ]

XLS_Type_RANGEPROTECTION = 0x0868

[line 191]

[ Top ]

XLS_Type_RIGHTMARGIN = 0x0027

[line 142]

[ Top ]

XLS_Type_RK = 0x027e

[line 186]

[ Top ]

XLS_Type_ROW = 0x0208

[line 181]

[ Top ]

XLS_Type_SCL = 0x00a0

[line 160]

[ Top ]

XLS_Type_SHAREDFMLA = 0x04bc

[line 189]

[ Top ]

XLS_Type_SHEET = 0x0085

[line 158]

[ Top ]

XLS_Type_SHEETPR = 0x0081

[line 155]

[ Top ]

XLS_Type_SST = 0x00fc

[line 169]

[ Top ]

XLS_Type_STRING = 0x0207

[line 180]

[ Top ]

XLS_Type_STYLE = 0x0293

[line 187]

[ Top ]

XLS_Type_TOPMARGIN = 0x0028

[line 143]

[ Top ]

XLS_Type_TXO = 0x01b6

[line 173]

[ Top ]

XLS_Type_UNKNOWN = 0xffff

[line 192]

[ Top ]

XLS_Type_VCENTER = 0x0084

[line 157]

[ Top ]

XLS_Type_VERTICALPAGEBREAKS = 0x001a

[line 137]

[ Top ]

XLS_Type_WINDOW2 = 0x023e

[line 185]

[ Top ]

XLS_Type_XF = 0x00e0

[line 165]

[ Top ]

XLS_WorkbookGlobals = 0x0005

[line 125]

[ Top ]

XLS_Worksheet = 0x0010

[line 126]

[ Top ]

Class: PHPExcel_Reader_Excel5

Class Overview

Author(s):

Copyright:

Variables

Constants

Methods

Class Details

Tags:

Class Variables

$_codepage =

Tags:

$_data =

Tags:

$_dataSize =

Tags:

$_definedname =

Tags:

$_drawingData =

Tags:

$_drawingGroupData =

Tags:

$_externalBooks =

Tags:

$_formats =

Tags:

$_frozen =

Tags:

$_isFitToPages =

Tags:

$_loadSheetsOnly = null

Tags:

$_mapCellStyleXfIndex =

Tags:

$_mapCellXfIndex =

Tags:

$_objFonts =

Tags:

$_objs =

Tags:

$_ole =

Tags:

$_palette =

Tags:

$_phpExcel =

Tags:

$_phpSheet =

Tags:

$_pos =

Tags:

$_readDataOnly = false

Tags:

$_readFilter = null

Tags:

$_ref =

Tags:

$_sharedFormulaParts =

Tags:

$_sharedFormulas =

Tags:

$_sheets =

Tags:

$_sst =

Tags:

$_version =

Tags:

$_xfIndex =

Tags:

Class Methods

method canRead [line 488]

Tags:

Parameters:

method getLoadSheetsOnly [line 426]

Tags:

method getReadDataOnly [line 404]

Tags:

method getReadFilter [line 460]

Tags:

method load [line 514]

Tags: