PHPExcel_Reader_Excel5
This class uses http://sourceforge.net/projects/phpexcelreader/parseXL
| category | PHPExcel |
|---|---|
| package | PHPExcel_Reader_Excel5 |
| copyright | Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel) |
_GetInt2d(string $data, int $pos) : int
string
int
int_GetInt4d(string $data, int $pos) : int
string
int
int__construct()
canRead(string $pFilename) : boolean
getIncludeCharts() : boolean
Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. If false (the default) it will ignore any charts defined in the workbook file.
| inherited_from | \PHPExcel_Reader_Abstract::getIncludeCharts() |
|---|
booleangetLoadSheetsOnly() : mixed
| inherited_from | \PHPExcel_Reader_Abstract::getLoadSheetsOnly() |
|---|
mixedgetReadDataOnly() : boolean
If false (the default) it will read data and formatting.
| inherited_from | \PHPExcel_Reader_Abstract::getReadDataOnly() |
|---|
booleanlistWorksheetInfo(string $pFilename)
listWorksheetNames(string $pFilename)
setIncludeCharts(boolean $pValue) : \PHPExcel_Reader_IReader
Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. Set to false (the default) to discard charts.
| inherited_from | \PHPExcel_Reader_Abstract::setIncludeCharts() |
|---|
boolean
setLoadAllSheets() : \PHPExcel_Reader_IReader
setLoadSheetsOnly(mixed $value) : \PHPExcel_Reader_IReader
| inherited_from | \PHPExcel_Reader_Abstract::setLoadSheetsOnly() |
|---|
mixedThis should be either an array of worksheet names to be loaded, or a string containing a single worksheet name. If NULL, then it tells the Reader to read all worksheets in the workbook
setReadDataOnly(boolean $pValue) : \PHPExcel_Reader_IReader
Set to false (the default) to advise the Reader to read both data and formatting for cells.
| inherited_from | \PHPExcel_Reader_Abstract::setReadDataOnly() |
|---|
boolean
setReadFilter(\PHPExcel_Reader_IReadFilter $pValue) : \PHPExcel_Reader_IReader
| inherited_from | \PHPExcel_Reader_Abstract::setReadFilter() |
|---|
\PHPExcel_Reader_IReadFilter
_openFile(string $pFilename) : resource
| inherited_from | \PHPExcel_Reader_Abstract::_openFile() |
|---|
string
\PHPExcel_Reader_Exception |
|---|
resource_GetIEEE754($rknum)
_UTF8toExcelDoubleQuoted(string $value) : string
Used for explicit string tokens in formulas. Example: hello"world --> "hello""world"
stringUTF-8 encoded string
string_createFormulaFromTokens(array $tokens, array $additionalData) : string
array
arrayAdditional binary data going with the formula
stringHuman readable formula_decodeCodepage(string $string) : string
Only used for BIFF5.
string
string_encodeUTF16(string $string, bool $compressed) : string
string
bool
string_extractNumber(string $data) : float
stringBinary string that is at least 8 bytes long
float_getFormulaFromData(string $formulaData, string $additionalData, string $baseCell) : string
stringThe binary data for the formula itself
stringAdditional binary data going with the formula
stringBase cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
stringHuman readable formula_getFormulaFromStructure(string $formulaStructure, string $baseCell) : string
stringThe complete binary data for the formula
stringBase cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
stringHuman readable formula_getNextToken(string $formulaData, string $baseCell) : array
stringFormula data
stringBase cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
\PHPExcel_Reader_Exception |
|---|
array_getSplicedRecordData() : array
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
array_includeCellRangeFiltered($cellRangeAddress)
_loadOLE(string $pFilename)
string
_makeKey($block, $valContext) : \PHPExcel_Reader_Excel5_RC4
| var | Block for which to create decrypto |
|---|---|
| var | MD5 context state |
_mapBorderStyle(int $index) : string
int
string_mapBuiltInColor(int $color) : array
intIndexed color
array_mapColor(int $subData) : array
int
array_mapColorBIFF5(int $subData) : array
int
array_mapErrorCode(int $subData) : string
'#N/A'
int
string_mapFillPattern(int $index) : string
int
string_parseRichText($is)
_readBIFF5CellRangeAddressFixed(string $subData) : string
'A2:B6' or 'A1' always fixed range section 2.5.14
string
\PHPExcel_Reader_Exception |
|---|
string_readBIFF5CellRangeAddressList(string $subData) : array
string
array_readBIFF8CellAddress(string $cellAddressStructure) : string
'A2' or '$A$2' section 3.3.4
string
string_readBIFF8CellAddressB(string $cellAddressStructure, string $baseCell) : string
Uses positive and negative values for row and column to indicate offsets from a base cell section 3.3.4
string
stringBase cell, only needed when formula contains tRefN tokens, e.g. with shared formulas
string_readBIFF8CellRangeAddress(string $subData) : string
'A2:B6' or '$A$2:$B$6' there are flags indicating whether column/row index is relative section 3.3.4
string
string_readBIFF8CellRangeAddressB(string $subData, string $baseCell) : string
Uses positive and negative values for row and column to indicate offsets from a base cell section 3.3.4
string
stringBase cell
stringCell range address_readBIFF8CellRangeAddressFixed(string $subData) : string
'A2:B6' or 'A1' always fixed range section 2.5.14
string
\PHPExcel_Reader_Exception |
|---|
string_readBIFF8CellRangeAddressList(string $subData) : array
string
array_readBIFF8Constant(string $valueData) : array
array('value' => '5', 'size' => 9)
string
array_readBIFF8ConstantArray(string $arrayData) : array
array('value' => '{1,2;3,4}', 'size' => 40} section 2.5.8
string
array_readBlank()
_readBof()
_readBoolErr()
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readBottomMargin()
_readByteStringLong(string $subData) : array
string
array_readByteStringShort(string $subData) : array
string
array_readCodepage()
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"
_readColInfo()
_readColor(int $color, array $palette, $version) : array
intIndexed color
arrayColor palette
arrayRGB color value, example: array('rgb' => 'FF0000')_readContinue()
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
_readDataValidation()
_readDataValidations()
_readDateMode()
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"
_readDefColWidth()
_readDefault()
Does nothing except for moving stream pointer forward to next record.
_readDefaultRowHeight()
_readDefinedName()
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"
_readDocumentSummaryInformation()
_readExternName()
_readExternSheet()
_readExternalBook()
_readFilepass()
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"
The decryption functions and objects used from here on in are based on the source of Spreadsheet-ParseExcel: http://search.cpan.org/~jmcnamara/Spreadsheet-ParseExcel/
_readFont()
_readFormat()
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"
_readFormula()
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readHcenter()
_readHeader()
_readHorizontalPageBreaks()
_readHyperLink()
_readImData()
_readLabel()
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"
_readLabelSst()
It replaces the LABEL record and RSTRING record used in BIFF2-BIFF5.
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readLeftMargin()
_readMergedCells()
This record contains the addresses of merged cell ranges in the current sheet.
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readMsoDrawing()
_readMsoDrawingGroup()
_readMulBlank()
All cells are located in the same row
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readMulRk()
All cells are located in the same row.
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readNote()
In Excel 95 (BIFF7) and earlier versions, this record stores a note (cell note). This feature was significantly enhanced in Excel 97.
_readNumber()
-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"
_readObj()
_readObjectProtect()
_readPageLayoutView()
_readPageSetup()
_readPalette()
_readPane()
_readPassword()
_readPrintGridlines()
_readProtect()
_readRGB(string $rgb) : array
stringEncoded RGB value (4 bytes)
array_readRangeProtection()
_readRecordData(string $data, int $pos, $len) : string
stringData stream to read from
intPosition to start reading from
stringRecord data_readRightMargin()
_readRk()
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"
_readRow()
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"
_readScenProtect()
_readScl()
_readSelection()
There is one such record for each pane in the sheet.
_readSharedFmla()
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.
_readSheet()
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"
_readSheetLayout()
Stores sheet tab color information.
_readSheetPr()
_readSheetProtection()
_readSheetRangeByRefIndex(int $index) : string | false
_readSst()
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"
_readString() : string
stringThe string contents as UTF-8_readStyle()
_readSummaryInformation()
_readTextObject()
_readTopMargin()
_readUnicodeString(string $subData, int $characterCount) : array
string
int
array_readUnicodeStringLong(string $subData) : array
string
array_readUnicodeStringShort(string $subData) : array
string
array_readVcenter()
_readVerticalPageBreaks()
_readWindow2()
_readXf()
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"
_readXfExt()
_uncompressByteString(string $string) : string
Only used for BIFF8.
string
string_verifyPassword($password, $docid, $salt_data, $hashedsalt_data, $valContext) : bool
| var | Password to check |
|---|---|
| var | Document id |
| var | Salt data |
| var | Hashed salt data |
| var | &$valContext Set to the MD5 context of the value |
boolSuccess$_fileHandle
| inherited_from | \PHPExcel_Reader_Abstract::$$_fileHandle |
|---|
$_includeCharts : boolean
| inherited_from | \PHPExcel_Reader_Abstract::$$_includeCharts |
|---|
$_loadSheetsOnly : array
If null, then all worksheets will be loaded.
| inherited_from | \PHPExcel_Reader_Abstract::$$_loadSheetsOnly |
|---|
$_readDataOnly : boolean
| inherited_from | \PHPExcel_Reader_Abstract::$$_readDataOnly |
|---|
$_readFilter : \PHPExcel_Reader_IReadFilter
| inherited_from | \PHPExcel_Reader_Abstract::$$_readFilter |
|---|
$_cellNotes : array
$_codepage : string
Only important for BIFF5 (Excel 5.0 - Excel 95) For BIFF8 (Excel 97 - Excel 2003) this will always have the value 'UTF-16LE'
$_data : string
(Includes workbook globals substream as well as sheet substreams)
$_dataSize : int
$_definedname : array
$_documentSummaryInformation : string
$_drawingData : string
$_drawingGroupData : string
$_encryption : int
$_encryptionStartPos : int
$_externalBooks : array
$_externalNames : array
$_formats : array
$_frozen : boolean
See WINDOW2 record.
$_isFitToPages : boolean
See SHEETPR record.
$_mapCellStyleXfIndex : array
$_mapCellXfIndex : array
$_md5Ctxt : string
$_objFonts : array
$_objs : array
One OBJ record contributes with one entry.
$_palette : array
$_phpExcel : \PHPExcel
$_phpSheet : \PHPExcel_Worksheet
$_pos : integer
$_rc4Key : \PHPExcel_Reader_Excel5_RC4
$_rc4Pos : int
$_ref : array
Only applies to BIFF8.
$_sharedFormulaParts : array
One FORMULA record contributes with one value if it refers to a shared formula.
$_sharedFormulas : array
One SHAREDFMLA record contributes with one value.
$_sheets : array
$_sst : array
Only applies to BIFF8.
$_summaryInformation : string
$_textObjects : array
One TXO record corresponds with one entry.
$_userDefinedProperties : string
$_version : int
$_xfIndex : int
MS_BIFF_CRYPTO_NONE
MS_BIFF_CRYPTO_RC4
MS_BIFF_CRYPTO_XOR
REKEY_BLOCK
XLS_BIFF7
XLS_BIFF8
XLS_Type_ARRAY
XLS_Type_BLANK
XLS_Type_BOF
XLS_Type_BOOLERR
XLS_Type_BOTTOMMARGIN
XLS_Type_CODEPAGE
XLS_Type_COLINFO
XLS_Type_CONTINUE
XLS_Type_DATAVALIDATION
XLS_Type_DATAVALIDATIONS
XLS_Type_DATEMODE
XLS_Type_DBCELL
XLS_Type_DEFAULTROWHEIGHT
XLS_Type_DEFCOLWIDTH
XLS_Type_DEFINEDNAME
XLS_Type_DIMENSION
XLS_Type_EOF
XLS_Type_EXTERNALBOOK
XLS_Type_EXTERNNAME
XLS_Type_EXTERNSHEET
XLS_Type_EXTSST
XLS_Type_FILEPASS
XLS_Type_FONT
XLS_Type_FOOTER
XLS_Type_FORMAT
XLS_Type_FORMULA
XLS_Type_HCENTER
XLS_Type_HEADER
XLS_Type_HORIZONTALPAGEBREAKS
XLS_Type_HYPERLINK
XLS_Type_IMDATA
XLS_Type_INDEX
XLS_Type_LABEL
XLS_Type_LABELSST
XLS_Type_LEFTMARGIN
XLS_Type_MERGEDCELLS
XLS_Type_MSODRAWING
XLS_Type_MSODRAWINGGROUP
XLS_Type_MULBLANK
XLS_Type_MULRK
XLS_Type_NOTE
XLS_Type_NUMBER
XLS_Type_OBJ
XLS_Type_OBJECTPROTECT
XLS_Type_PAGELAYOUTVIEW
XLS_Type_PAGESETUP
XLS_Type_PALETTE
XLS_Type_PANE
XLS_Type_PASSWORD
XLS_Type_PRINTGRIDLINES
XLS_Type_PROTECT
XLS_Type_RANGEPROTECTION
XLS_Type_RIGHTMARGIN
XLS_Type_RK
XLS_Type_ROW
XLS_Type_SCENPROTECT
XLS_Type_SCL
XLS_Type_SELECTION
XLS_Type_SHAREDFMLA
XLS_Type_SHEET
XLS_Type_SHEETLAYOUT
XLS_Type_SHEETPR
XLS_Type_SHEETPROTECTION
XLS_Type_SST
XLS_Type_STRING
XLS_Type_STYLE
XLS_Type_TOPMARGIN
XLS_Type_TXO
XLS_Type_UNKNOWN
XLS_Type_VCENTER
XLS_Type_VERTICALPAGEBREAKS
XLS_Type_WINDOW2
XLS_Type_XF
XLS_Type_XFEXT
XLS_WorkbookGlobals
XLS_Worksheet