$_builtInStyles = array()
[line 283]
Built-in styles
Built-in styles
Tags:
$_codepage =
[line 255]
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:
$_data =
[line 212]
Stream data that is read.
Stream data that is read. Includes workbook globals substream as well as sheet substreams
Tags:
$_dataSize =
[line 219]
Size in bytes of $this->_data
Size in bytes of $this->_data
Tags:
$_definedname = array()
[line 318]
Defined names
Defined names
Tags:
$_drawingData = ''
[line 360]
The combined MSODRAWING data (per sheet)
The combined MSODRAWING data (per sheet)
Tags:
$_drawingGroupData = ''
[line 353]
The combined MSODRAWINGGROUP data
The combined MSODRAWINGGROUP data
Tags:
$_externalBooks = array()
[line 304]
External books
External books
Tags:
$_fonts = array()
[line 262]
Shared fonts
Shared fonts
Tags:
$_formats = array()
[line 269]
Shared formats
Shared formats
Tags:
$_frozen = false
[line 332]
Panes are frozen? (in sheet currently being read).
Panes are frozen? (in sheet currently being read). See WINDOW2 record.
Tags:
$_isFitToPages =
[line 339]
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:
$_loadSheetsOnly = null
[line 191]
Restict which sheets should be loaded?
Restict which sheets should be loaded?
Tags:
$_objs = array()
[line 346]
Objects.
Objects. One OBJ record contributes with one entry.
Tags:
$_ole =
[line 205]
OLE reader
OLE reader
Tags:
$_palette =
[line 290]
Color palette
Color palette
Tags:
$_phpExcel =
[line 233]
Workbook to be returned by the reader.
Workbook to be returned by the reader.
Tags:
$_phpSheet =
[line 240]
Worksheet that is currently being built by the reader.
Worksheet that is currently being built by the reader.
Tags:
$_pos =
[line 226]
Current position in stream
Current position in stream
Tags:
$_readDataOnly = false
[line 184]
Read data only?
Read data only?
Tags:
$_readFilter = null
[line 198]
PHPExcel_Reader_IReadFilter instance
PHPExcel_Reader_IReadFilter instance
Tags:
$_ref = array()
[line 311]
REF structures.
REF structures. Only applies to BIFF8.
Tags:
$_sheets = array()
[line 297]
Worksheets
Worksheets
Tags:
$_sst = array()
[line 325]
Shared strings.
Shared strings. Only applies to BIFF8.
Tags:
$_version =
[line 247]
BIFF version
BIFF version
Tags:
$_xf = array()
[line 276]
Shared styles
Shared styles
Tags:
method getLoadSheetsOnly [line 387]
mixed getLoadSheetsOnly(
)
|
|
Get which sheets to load
Get which sheets to load
Tags:
method getReadDataOnly [line 367]
boolean getReadDataOnly(
)
|
|
Read data only?
Read data only?
Tags:
method getReadFilter [line 416]
Read filter
Read filter
Tags:
method load [line 442]
void load(
string
$pFilename)
|
|
Loads PHPExcel from file
Loads PHPExcel from file
Tags:
Parameters:
method setLoadAllSheets [line 406]
Set all sheets to load
Set all sheets to load
Tags:
method setLoadSheetsOnly [line 397]
void setLoadSheetsOnly(
[mixed
$value = null])
|
|
Set which sheets to load
Set which sheets to load
Tags:
Parameters:
method setReadDataOnly [line 377]
void setReadDataOnly(
[boolean
$pValue = false])
|
|
Set read data only
Set read data only
Tags:
Parameters:
method setReadFilter [line 425]
void setReadFilter(
$pValue)
|
|
Set read filter
Set read filter
Tags:
Parameters:
constructor __construct [line 432]
PHPExcel_Reader_Excel5 __construct(
)
|
|
Create a new PHPExcel_Reader_Excel5 instance
Create a new PHPExcel_Reader_Excel5 instance
Tags:
method _createFormulaFromTokens [line 3306]
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:
Parameters:
method _createNumber [line 4365]
void _createNumber(
$spos)
|
|
Reads 8 bytes and returns IEEE 754 float
Reads 8 bytes and returns IEEE 754 float
Tags:
Parameters:
method _decodeCodepage [line 4486]
string _decodeCodepage(
string
$string)
|
|
Convert string to UTF-8.
Convert string to UTF-8. Only used for BIFF5.
Tags:
Parameters:
method _encodeUTF16 [line 4447]
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:
Parameters:
method _extractNumber [line 4391]
void _extractNumber(
$subData)
|
|
Same as _createNumber, but not hardcoded to read from $this->_data
Same as _createNumber, but not hardcoded to read from $this->_data
Tags:
Parameters:
method _getFormulaFromData [line 3281]
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:
Parameters:
method _getFormulaFromStructure [line 3243]
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:
Parameters:
method _GetIEEE754 [line 4414]
void _GetIEEE754(
$rknum)
|
|
Tags:
Parameters:
method _GetInt2d [line 4509]
int _GetInt2d(
string
$data, int
$pos)
|
|
Read 16-bit unsigned integer
Read 16-bit unsigned integer
Tags:
Parameters:
method _GetInt4d [line 4521]
int _GetInt4d(
string
$data, int
$pos)
|
|
Read 32-bit signed integer
Read 32-bit signed integer
Tags:
Parameters:
method _getNextToken [line 3447]
array _getNextToken(
string
$formulaData)
|
|
Fetch next token from binary formula data
Fetch next token from binary formula data
Tags:
Parameters:
method _getSplicedRecordData [line 3204]
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:
method _mapBorderStyle [line 4573]
string _mapBorderStyle(
int
$index)
|
|
Map border style
Map border style OpenOffice documentation: 2.5.11
Tags:
Parameters:
method _mapBuiltInColor [line 4653]
array _mapBuiltInColor(
int
$color)
|
|
Map built-in color to RGB value
Map built-in color to RGB value
Tags:
Parameters:
method _mapColor [line 4743]
array _mapColor(
int
$subData)
|
|
Map color array from BIFF8 built-in color index
Map color array from BIFF8 built-in color index
Tags:
Parameters:
method _mapColorBIFF5 [line 4674]
array _mapColorBIFF5(
int
$subData)
|
|
Map color array from BIFF5 built-in color index
Map color array from BIFF5 built-in color index
Tags:
Parameters:
method _mapErrorCode [line 4633]
string _mapErrorCode(
int
$subData)
|
|
Map error code, e.
Map error code, e.g. '#N/A'
Tags:
Parameters:
method _mapFillPattern [line 4601]
string _mapFillPattern(
int
$index)
|
|
Get fill pattern from index
Get fill pattern from index OpenOffice documentation: 2.5.12
Tags:
Parameters:
method _readBIFF8CellAddress [line 3954]
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:
Parameters:
method _readBIFF8CellRangeAddress [line 4010]
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:
Parameters:
method _readBIFF8CellRangeAddressFixed [line 3982]
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:
Parameters:
method _readBIFF8CellRangeAddressList [line 4052]
array _readBIFF8CellRangeAddressList(
string
$subData)
|
|
Read BIFF8 cell range address list
Read BIFF8 cell range address list section 2.5.15
Tags:
Parameters:
method _readBIFF8Constant [line 4164]
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:
Parameters:
method _readBIFF8ConstantArray [line 4128]
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:
Parameters:
method _readBlank [line 2780]
Read BLANK record
Read BLANK record
Tags:
method _readBoolErr [line 2634]
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:
method _readBottomMargin [line 2086]
void _readBottomMargin(
)
|
|
Read BOTTOMMARGIN record
Read BOTTOMMARGIN record
Tags:
method _readByteStringLong [line 4256]
array _readByteStringLong(
string
$subData)
|
|
Read byte string (16-bit string length)
Read byte string (16-bit string length) OpenOffice documentation: 2.5.2
Tags:
Parameters:
method _readByteStringShort [line 4236]
array _readByteStringShort(
string
$subData)
|
|
Read byte string (8-bit string length)
Read byte string (8-bit string length) OpenOffice documentation: 2.5.2
Tags:
Parameters:
method _readCodepage [line 863]
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:
method _readColInfo [line 2216]
Read COLINFO record
Read COLINFO record
Tags:
method _readColor [line 4544]
array _readColor(
int
$color)
|
|
Read color
Read color
Tags:
Parameters:
method _readDateMode [line 1043]
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:
method _readDefault [line 823]
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:
method _readDefaultRowHeight [line 1857]
void _readDefaultRowHeight(
)
|
|
Read DEFAULTROWHEIGHT record
Read DEFAULTROWHEIGHT record
Tags:
method _readDefColWidth [line 2200]
Read DEFCOLWIDTH record
Read DEFCOLWIDTH record
Tags:
method _readDefinedName [line 1585]
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:
method _readExternalBook [line 1485]
void _readExternalBook(
)
|
|
Read EXTERNALBOOK record
Read EXTERNALBOOK record
Tags:
method _readExternSheet [line 1548]
Read EXTERNSHEET record
Read EXTERNSHEET record
Tags:
method _readFilepass [line 843]
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:
method _readFont [line 1060]
Read a FONT record
Read a FONT record
Tags:
method _readFooter [line 1973]
Read FOOTER record
Read FOOTER record
Tags:
method _readFormat [line 1141]
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:
method _readFormula [line 2537]
Read FORMULA record This record contains the token array and the result of a formula cell.
Read FORMULA record This record contains the token array and the result of a formula cell.
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
Tags:
method _readHcenter [line 1995]
Read HCENTER record
Read HCENTER record
Tags:
method _readHeader [line 1951]
Read HEADER record
Read HEADER record
Tags:
method _readHorizontalPageBreaks [line 1901]
void _readHorizontalPageBreaks(
)
|
|
Read HORIZONTALPAGEBREAKS record
Read HORIZONTALPAGEBREAKS record
Tags:
method _readHyperLink [line 2961]
Read HYPERLINK record
Read HYPERLINK record
Tags:
method _readImData [line 3123]
Read IMDATA record
Read IMDATA record
Tags:
method _readLabel [line 2737]
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:
method _readLabelSst [line 2361]
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:
method _readLeftMargin [line 2035]
Read LEFTMARGIN record
Read LEFTMARGIN record
Tags:
method _readMergedCells [line 2943]
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:
method _readMsoDrawing [line 2812]
Read MSODRAWING record
Read MSODRAWING record
Tags:
method _readMsoDrawingGroup [line 1634]
void _readMsoDrawingGroup(
)
|
|
Read MSODRAWINGGROUP record
Read MSODRAWINGGROUP record
Tags:
method _readMulBlank [line 2694]
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:
method _readMulRk [line 2436]
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:
method _readNumber [line 2492]
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:
method _readObj [line 2827]
Read OBJ record
Read OBJ record
Tags:
method _readPageSetup [line 2103]
Read PAGESETUP record
Read PAGESETUP record
Tags:
method _readPalette [line 1419]
Read PALETTE record
Read PALETTE record
Tags:
method _readPane [line 2908]
Read PANE record
Read PANE record
Tags:
method _readPassword [line 2182]
PASSWORD - Sheet protection (hashed) password (BIFF2 through BIFF8)
PASSWORD - Sheet protection (hashed) password (BIFF2 through BIFF8)
Tags:
method _readPrintGridlines [line 1837]
void _readPrintGridlines(
)
|
|
Read PRINTGRIDLINES record
Read PRINTGRIDLINES record
Tags:
method _readProtect [line 2160]
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:
method _readRangeProtection [line 3067]
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:
method _readRGB [line 4212]
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:
Parameters:
method _readRightMargin [line 2052]
Read RIGHTMARGIN record
Read RIGHTMARGIN record
Tags:
method _readRk [line 2312]
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:
method _readRow [line 2265]
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:
method _readScl [line 2885]
Read SCL record
Read SCL record
Tags:
method _readSheet [line 1451]
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:
method _readSheetPr [line 1874]
Read SHEETPR record
Read SHEETPR record
Tags:
method _readSheetRangeByRefIndex [line 4082]
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:
Parameters:
method _readSst [line 1656]
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:
method _readStyle [line 1386]
Read STYLE record
Read STYLE record
Tags:
method _readTopMargin [line 2069]
Read TOPMARGIN record
Read TOPMARGIN record
Tags:
method _readUnicodeString [line 4325]
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:
Parameters:
method _readUnicodeStringLong [line 4301]
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:
Parameters:
method _readUnicodeStringShort [line 4278]
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:
Parameters:
method _readVcenter [line 2015]
Read VCENTER record
Read VCENTER record
Tags:
method _readVerticalPageBreaks [line 1926]
void _readVerticalPageBreaks(
)
|
|
Read VERTICALPAGEBREAKS record
Read VERTICALPAGEBREAKS record
Tags:
method _readWindow2 [line 2855]
Read WINDOW2 record
Read WINDOW2 record
Tags:
method _readXf [line 1173]
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:
method _uncompressByteString [line 4470]
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:
Parameters:
method _UTF8toExcelDoubleQuoted [line 4357]
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:
Parameters: