Docs For Class PHPExcel_Reader

method canRead [line 497]

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

mixed getLoadSheetsOnly(
)

Get which sheets to load

Tags:

access:

public

[ Top ]

method getReadDataOnly [line 413]

boolean getReadDataOnly(
)

Read data only?

Tags:

access:

public

[ Top ]

method getReadFilter [line 469]

PHPExcel_Reader_IReadFilter getReadFilter(
)

Read filter

Tags:

access:

public

[ Top ]

method load [line 523]

void load(
string
$pFilename)

Loads PHPExcel from file

Tags:

throws:	Exception
access:	public

Parameters:

string

$pFilename

[ Top ]

method setLoadAllSheets [line 458]

PHPExcel_Reader_Excel5 setLoadAllSheets(
)

Set all sheets to load

Tags:

access:

public

[ Top ]

method setLoadSheetsOnly [line 446]

PHPExcel_Reader_Excel5 setLoadSheetsOnly(
[mixed
$value = null])

Set which sheets to load

Tags:

access:

public

Parameters:

mixed

$value

[ Top ]

method setReadDataOnly [line 424]

PHPExcel_Reader_Excel5 setReadDataOnly(
[boolean
$pValue = false])

Set read data only

Tags:

access:

public

Parameters:

boolean

$pValue

[ Top ]

method setReadFilter [line 479]

PHPExcel_Reader_Excel5 setReadFilter(

$pValue)

Set read filter

Tags:

access:

public

Parameters:

PHPExcel_Reader_IReadFilter

$pValue

[ Top ]

constructor __construct [line 487]

PHPExcel_Reader_Excel5 __construct(
)

Create a new PHPExcel_Reader_Excel5 instance

Tags:

access:

public

[ Top ]

method _createFormulaFromTokens [line 4193]

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

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

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

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

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

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

void _GetIEEE754(

$rknum)

Tags:

access:

private

Parameters:

$rknum

[ Top ]

method _GetInt2d [line 5610]

int _GetInt2d(
string
$data, int
$pos)

Read 16-bit unsigned integer

Tags:

access:

private

Parameters:

string	$data
int	$pos

[ Top ]

method _GetInt4d [line 5622]

int _GetInt4d(
string
$data, int
$pos)

Read 32-bit signed integer

Tags:

access:

private

Parameters:

string	$data
int	$pos

[ Top ]

method _getNextToken [line 4342]

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

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

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

array _mapBuiltInColor(
int
$color)

Map built-in color to RGB value

Tags:

access:

private

Parameters:

int

$color

Indexed color

[ Top ]

method _mapColor [line 5846]

array _mapColor(
int
$subData)

Map color array from BIFF8 built-in color index

Tags:

access:

private

Parameters:

int

$subData

[ Top ]

method _mapColorBIFF5 [line 5777]

array _mapColorBIFF5(
int
$subData)

Map color array from BIFF5 built-in color index

Tags:

access:

private

Parameters:

int

$subData

[ Top ]

method _mapErrorCode [line 5734]

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

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

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 _readBIFF5CellRangeAddressList [line 5177]

array _readBIFF5CellRangeAddressList(
string
$subData)

Read BIFF5 cell range address list

Read BIFF5 cell range address list section 2.5.15

Tags:

access:

private

Parameters:

string

$subData

[ Top ]

method _readBIFF8CellAddress [line 4868]

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

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

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 _readBIFF8CellRangeAddressB [line 5070]

string _readBIFF8CellRangeAddressB(
string
$subData, [string
$baseCell = 'A1'])

Reads a cell range address in BIFF8 for shared formulas.

Reads a cell range 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:

return:	Cell range address
access:	private

Parameters:

string	$subData
string	$baseCell	Base cell

[ Top ]

method _readBIFF8CellRangeAddressFixed [line 4980]

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

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

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

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

void _readBlank(
)

Read BLANK record

Tags:

access:

private

[ Top ]

method _readBoolErr [line 3235]

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

void _readBottomMargin(
)

Read BOTTOMMARGIN record

Tags:

access:

private

[ Top ]

method _readByteStringLong [line 5394]

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

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

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

void _readColInfo(
)

Read COLINFO record

Tags:

access:

private

[ Top ]

method _readColor [line 5645]

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

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

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

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

void _readDefaultRowHeight(
)

Read DEFAULTROWHEIGHT record

Tags:

access:

private

[ Top ]

method _readDefColWidth [line 2685]

void _readDefColWidth(
)

Read DEFCOLWIDTH record

Tags:

access:

private

[ Top ]

method _readDefinedName [line 2012]

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

void _readExternalBook(
)

Read EXTERNALBOOK record

Tags:

access:

private

[ Top ]

method _readExternSheet [line 1976]

void _readExternSheet(
)

Read EXTERNSHEET record

Tags:

access:

private

[ Top ]

method _readFilepass [line 992]

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

void _readFont(
)

Read a FONT record

Tags:

access:

private

[ Top ]

method _readFooter [line 2410]

void _readFooter(
)

Read FOOTER record

Tags:

access:

private

[ Top ]

method _readFormat [line 1305]

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

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

void _readHcenter(
)

Read HCENTER record

Tags:

access:

private

[ Top ]

method _readHeader [line 2383]

void _readHeader(
)

Read HEADER record

Tags:

access:

private

[ Top ]

method _readHorizontalPageBreaks [line 2328]

void _readHorizontalPageBreaks(
)

Read HORIZONTALPAGEBREAKS record

Tags:

access:

private

[ Top ]

method _readHyperLink [line 3601]

void _readHyperLink(
)

Read HYPERLINK record

Tags:

access:

private

[ Top ]

method _readImData [line 3964]

void _readImData(
)

Read IMDATA record

Tags:

access:

private

[ Top ]

method _readLabel [line 3333]

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

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

void _readLeftMargin(
)

Read LEFTMARGIN record

Tags:

access:

private

[ Top ]

method _readMergedCells [line 3582]

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

void _readMsoDrawing(
)

Read MSODRAWING record

Tags:

access:

private

[ Top ]

method _readMsoDrawingGroup [line 2062]

void _readMsoDrawingGroup(
)

Read MSODRAWINGGROUP record

Tags:

access:

private

[ Top ]

method _readMulBlank [line 3292]

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

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

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

void _readObj(
)

Read OBJ record

Tags:

access:

private

[ Top ]

method _readObjectProtect [line 2644]

void _readObjectProtect(
)

OBJECTPROTECT

Tags:

access:

private

[ Top ]

method _readPageSetup [line 2542]

void _readPageSetup(
)

Read PAGESETUP record

Tags:

access:

private

[ Top ]

method _readPalette [line 1840]

void _readPalette(
)

Read PALETTE record

Tags:

access:

private

[ Top ]

method _readPane [line 3499]

void _readPane(
)

Read PANE record

Tags:

access:

private

[ Top ]

method _readPassword [line 2667]

void _readPassword(
)

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

Tags:

access:

private

[ Top ]

method _readPrintGridlines [line 2267]

void _readPrintGridlines(
)

Read PRINTGRIDLINES record

Tags:

access:

private

[ Top ]

method _readProtect [line 2599]

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

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

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

void _readRightMargin(
)

Read RIGHTMARGIN record

Tags:

access:

private

[ Top ]

method _readRk [line 2830]

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

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 _readScenProtect [line 2621]

void _readScenProtect(
)

SCENPROTECT

Tags:

access:

private

[ Top ]

method _readScl [line 3478]

void _readScl(
)

Read SCL record

Tags:

access:

private

[ Top ]

method _readSelection [line 3526]

void _readSelection(
)

Read SELECTION record.

Read SELECTION record. There is one such record for each pane in the sheet.

Tags:

access:

private

[ Top ]

method _readSharedFmla [line 3176]

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

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 _readSheetLayout [line 3776]

void _readSheetLayout(
)

Read SHEETLAYOUT record.

Read SHEETLAYOUT record. Stores sheet tab color information.

Tags:

access:

private

[ Top ]

method _readSheetPr [line 2302]

void _readSheetPr(
)

Read SHEETPR record

Tags:

access:

private

[ Top ]

method _readSheetProtection [line 3815]

void _readSheetProtection(
)

Read SHEETPROTECTION record

Tags:

access:

private

[ Top ]

method _readSheetRangeByRefIndex [line 5207]

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

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

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

void _readStyle(
)

Read STYLE record

Tags:

access:

private

[ Top ]

method _readTopMargin [line 2508]

void _readTopMargin(
)

Read TOPMARGIN record

Tags:

access:

private

[ Top ]

method _readUnicodeString [line 5464]

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

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

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

void _readVcenter(
)

Read VCENTER record

Tags:

access:

private

[ Top ]

method _readVerticalPageBreaks [line 2356]

void _readVerticalPageBreaks(
)

Read VERTICALPAGEBREAKS record

Tags:

access:

private

[ Top ]

method _readWindow2 [line 3447]

void _readWindow2(
)

Read WINDOW2 record

Tags:

access:

private

[ Top ]

method _readXf [line 1342]

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 _readXfExt [line 1624]

void _readXfExt(
)

Tags:

access:

private

[ Top ]

method _uncompressByteString [line 5581]

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

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 ]

XLS_BIFF7 = 0x0500

[line 127]

[ Top ]

XLS_BIFF8 = 0x0600

[line 126]

[ Top ]

XLS_Type_ARRAY = 0x0221

[line 189]

[ Top ]

XLS_Type_BLANK = 0x0201

[line 182]

[ Top ]

XLS_Type_BOF = 0x0809

[line 196]

[ Top ]

XLS_Type_BOOLERR = 0x0205

[line 185]

[ Top ]

XLS_Type_BOTTOMMARGIN = 0x0029

[line 150]

[ Top ]

XLS_Type_CODEPAGE = 0x0042

[line 156]

[ Top ]

XLS_Type_COLINFO = 0x007d

[line 159]

[ Top ]

XLS_Type_CONTINUE = 0x003c

[line 154]

[ Top ]

XLS_Type_DATEMODE = 0x0022

[line 146]

[ Top ]

XLS_Type_DBCELL = 0x00d7

[line 170]

[ Top ]

XLS_Type_DEFAULTROWHEIGHT = 0x0225

[line 190]

[ Top ]

XLS_Type_DEFCOLWIDTH = 0x0055

[line 157]

[ Top ]

XLS_Type_DEFINEDNAME = 0x0018

[line 141]

[ Top ]

XLS_Type_DIMENSION = 0x0200

[line 181]

[ Top ]

XLS_Type_EOF = 0x000a

[line 133]

[ Top ]

XLS_Type_EXTERNALBOOK = 0x01ae

[line 178]

[ Top ]

XLS_Type_EXTERNSHEET = 0x0017

[line 140]

[ Top ]

XLS_Type_EXTSST = 0x00ff

[line 177]

[ Top ]

XLS_Type_FILEPASS = 0x002f

[line 152]

[ Top ]

XLS_Type_FONT = 0x0031

[line 153]

[ Top ]

XLS_Type_FOOTER = 0x0015

[line 139]

[ Top ]

XLS_Type_FORMAT = 0x041e

[line 194]

[ Top ]

XLS_Type_FORMULA = 0x0006

[line 132]

[ Top ]

XLS_Type_HCENTER = 0x0083

[line 162]

[ Top ]

XLS_Type_HEADER = 0x0014

[line 138]

[ Top ]

XLS_Type_HORIZONTALPAGEBREAKS = 0x001b

[line 143]

[ Top ]

XLS_Type_HYPERLINK = 0x01b8

[line 180]

[ Top ]

XLS_Type_IMDATA = 0x007f

[line 160]

[ Top ]

XLS_Type_INDEX = 0x020b

[line 188]

[ Top ]

XLS_Type_LABEL = 0x0204

[line 184]

[ Top ]

XLS_Type_LABELSST = 0x00fd

[line 176]

[ Top ]

XLS_Type_LEFTMARGIN = 0x0026

[line 147]

[ Top ]

XLS_Type_MERGEDCELLS = 0x00e5

[line 172]

[ Top ]

XLS_Type_MSODRAWING = 0x00ec

[line 174]

[ Top ]

XLS_Type_MSODRAWINGGROUP = 0x00eb

[line 173]

[ Top ]

XLS_Type_MULBLANK = 0x00be

[line 169]

[ Top ]

XLS_Type_MULRK = 0x00bd

[line 168]

[ Top ]

XLS_Type_NOTE = 0x001c

[line 144]

[ Top ]

XLS_Type_NUMBER = 0x0203

[line 183]

[ Top ]

XLS_Type_OBJ = 0x005d

[line 158]

[ Top ]

XLS_Type_OBJECTPROTECT = 0x0063

[line 135]

[ Top ]

XLS_Type_PAGESETUP = 0x00a1

[line 167]

[ Top ]

XLS_Type_PALETTE = 0x0092

[line 165]

[ Top ]

XLS_Type_PANE = 0x0041

[line 155]

[ Top ]

XLS_Type_PASSWORD = 0x0013

[line 137]

[ Top ]

XLS_Type_PRINTGRIDLINES = 0x002b

[line 151]

[ Top ]

XLS_Type_PROTECT = 0x0012

[line 134]

[ Top ]

XLS_Type_RANGEPROTECTION = 0x0868

[line 198]

[ Top ]

XLS_Type_RIGHTMARGIN = 0x0027

[line 148]

[ Top ]

XLS_Type_RK = 0x027e

[line 192]

[ Top ]

XLS_Type_ROW = 0x0208

[line 187]

[ Top ]

XLS_Type_SCENPROTECT = 0x00dd

[line 136]

[ Top ]

XLS_Type_SCL = 0x00a0

[line 166]

[ Top ]

XLS_Type_SELECTION = 0x001d

[line 145]

[ Top ]

XLS_Type_SHAREDFMLA = 0x04bc

[line 195]

[ Top ]

XLS_Type_SHEET = 0x0085

[line 164]

[ Top ]

XLS_Type_SHEETLAYOUT = 0x0862

[line 199]

[ Top ]

XLS_Type_SHEETPR = 0x0081

[line 161]

[ Top ]

XLS_Type_SHEETPROTECTION = 0x0867

[line 197]

[ Top ]

XLS_Type_SST = 0x00fc

[line 175]

[ Top ]

XLS_Type_STRING = 0x0207

[line 186]

[ Top ]

XLS_Type_STYLE = 0x0293

[line 193]

[ Top ]

XLS_Type_TOPMARGIN = 0x0028

[line 149]

[ Top ]

XLS_Type_TXO = 0x01b6

[line 179]

[ Top ]

XLS_Type_UNKNOWN = 0xffff

[line 201]

[ Top ]

XLS_Type_VCENTER = 0x0084

[line 163]

[ Top ]

XLS_Type_VERTICALPAGEBREAKS = 0x001a

[line 142]

[ Top ]

XLS_Type_WINDOW2 = 0x023e

[line 191]

[ Top ]

XLS_Type_XF = 0x00e0

[line 171]

[ Top ]

XLS_Type_XFEXT = 0x087d

[line 200]

[ Top ]

XLS_WorkbookGlobals = 0x0005

[line 128]

[ Top ]

XLS_Worksheet = 0x0010

[line 129]

[ 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 497]

Tags:

Parameters:

method getLoadSheetsOnly [line 435]

Tags:

method getReadDataOnly [line 413]

Tags:

method getReadFilter [line 469]

Tags:

method load [line 523]

Tags: