Class PHPExcel_Reader_Excel5
PHPExcel_Reader_Excel5
This class uses http://sourceforge.net/projects/phpexcelreader/parseXL
- PHPExcel_Reader_Abstract implements PHPExcel_Reader_IReader
- PHPExcel_Reader_Excel5 implements PHPExcel_Reader_IReader
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Reader/Excel5.php
public
|
|
public
boolean
|
|
public
|
#
listWorksheetNames( string $pFilename )
Reads names of the worksheets from a file, without parsing the whole file to a PHPExcel object |
public
|
#
listWorksheetInfo( string $pFilename )
Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns) |
public
|
|
private
string
|
#
_readRecordData( string $data, integer $pos, integer $len )
Read record data from stream, decrypting as required |
private
|
|
private
|
|
private
|
|
private
|
#
_readDefault( )
Reads a general type of BIFF record. Does nothing except for moving stream pointer forward to next record. |
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
boolean
|
#
_verifyPassword( $password, $docid, $salt_data, $hashedsalt_data, & $valContext )
Verify RC4 file password |
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
#
_readProtect( )
PROTECT - Sheet protection (BIFF2 through BIFF8) if this record is omitted, then it also means no sheet protection |
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
#
_readLabelSst( )
Read LABELSST record This record represents a cell that contains a string. It replaces the LABEL record and RSTRING record used in BIFF2-BIFF5. |
private
|
#
_readMulRk( )
Read MULRK record This record represents a cell range containing RK value cells. All cells are located in the same row. |
private
|
#
_readNumber( )
Read NUMBER record This record represents a cell that contains a floating-point value. |
private
|
#
_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. |
private
|
#
_readSharedFmla( )
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. |
private
string
|
#
_readString( )
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 |
private
|
|
private
|
#
_readMulBlank( )
Read MULBLANK record This record represents a cell range of empty cells. All cells are located in the same row |
private
|
#
_readLabel( )
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. |
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
|
private
|
#
_readRangeProtection( )
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 |
private
|
|
private
|
#
_readContinue( )
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 |
private
array
|
#
_getSplicedRecordData( )
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 |
private
string
|
#
_getFormulaFromStructure( string $formulaStructure, string $baseCell = 'A1' )
Convert formula structure into human readable Excel formula like 'A3+A5*5' |
private
string
|
#
_getFormulaFromData( string $formulaData, string $additionalData = '', string $baseCell = 'A1' )
Take formula data and additional data for formula and return human readable formula |
private
string
|
#
_createFormulaFromTokens( array $tokens, array $additionalData, string $baseCell,… )
Take array of tokens together with additional data for formula and return human readable formula |
private
array
|
#
_getNextToken( string $formulaData, string $baseCell = 'A1' )
Fetch next token from binary formula data |
private
string
|
#
_readBIFF8CellAddress( string $cellAddressStructure )
Reads a cell address in BIFF8 e.g. 'A2' or '$A$2' section 3.3.4 |
private
string
|
#
_readBIFF8CellAddressB( string $cellAddressStructure, string $baseCell = 'A1' )
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 |
private
string
|
#
_readBIFF5CellRangeAddressFixed( string $subData )
Reads a cell range address in BIFF5 e.g. 'A2:B6' or 'A1' always fixed range section 2.5.14 |
private
string
|
#
_readBIFF8CellRangeAddressFixed( string $subData )
Reads a cell range address in BIFF8 e.g. 'A2:B6' or 'A1' always fixed range section 2.5.14 |
private
string
|
#
_readBIFF8CellRangeAddress( string $subData )
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 |
private
string
|
#
_readBIFF8CellRangeAddressB( string $subData, string $baseCell = 'A1' )
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 |
private
array
|
#
_readBIFF8CellRangeAddressList( string $subData )
Read BIFF8 cell range address list section 2.5.15 |
private
array
|
#
_readBIFF5CellRangeAddressList( string $subData )
Read BIFF5 cell range address list section 2.5.15 |
private
string|false
|
#
_readSheetRangeByRefIndex( integer $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 PHPExcel_Reader_Exception is thrown |
private static
array
|
#
_readBIFF8ConstantArray( string $arrayData )
read BIFF8 constant value array from array data returns e.g. array('value' => '{1,2;3,4}', 'size' => 40} section 2.5.8 |
private static
array
|
#
_readBIFF8Constant( string $valueData )
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) |
private static
array
|
|
private
array
|
#
_readByteStringShort( string $subData )
Read byte string (8-bit string length) OpenOffice documentation: 2.5.2 |
private
array
|
#
_readByteStringLong( string $subData )
Read byte string (16-bit string length) OpenOffice documentation: 2.5.2 |
private static
array
|
#
_readUnicodeStringShort( string $subData )
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. |
private static
array
|
#
_readUnicodeStringLong( string $subData )
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 |
private static
array
|
#
_readUnicodeString( string $subData, integer $characterCount )
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 |
private static
string
|
#
_UTF8toExcelDoubleQuoted( string $value )
Convert UTF-8 string to string surounded by double quotes. Used for explicit string tokens in formulas. Example: hello"world --> "hello""world" |
private static
float
|
|
private static
|
|
private static
string
|
#
_encodeUTF16( string $string, boolean $compressed = '' )
Get UTF-8 string from (compressed or uncompressed) UTF-16 string |
private static
string
|
#
_uncompressByteString( string $string )
Convert UTF-16 string in compressed notation to uncompressed form. Only used for BIFF8. |
private
string
|
|
public static
integer
|
|
public static
integer
|
|
private static
array
|
|
private static
string
|
|
private static
string
|
|
private static
string
|
|
private static
array
|
|
private static
array
|
|
private static
array
|
|
private
|
private
string
|
$_summaryInformation
Summary Information stream data. |
|
private
string
|
$_documentSummaryInformation
Extended Summary Information stream data. |
|
private
string
|
$_userDefinedProperties
User-Defined Properties stream data. |
|
private
string
|
$_data
Workbook stream data. (Includes workbook globals substream as well as sheet substreams) |
|
private
integer
|
$_dataSize
Size in bytes of $this->_data |
|
private
integer
|
$_pos
Current position in stream |
|
private
|
$_phpExcel
Workbook to be returned by the reader. |
|
private
|
$_phpSheet
Worksheet that is currently being built by the reader. |
|
private
integer
|
$_version
BIFF version |
|
private
string
|
$_codepage
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' |
|
private
array
|
$_formats
Shared formats |
|
private
array
|
$_objFonts
Shared fonts |
|
private
array
|
$_palette
Color palette |
|
private
array
|
$_sheets
Worksheets |
|
private
array
|
$_externalBooks
External books |
|
private
array
|
$_ref
REF structures. Only applies to BIFF8. |
|
private
array
|
$_externalNames
External names |
|
private
array
|
$_definedname
Defined names |
|
private
array
|
$_sst
Shared strings. Only applies to BIFF8. |
|
private
boolean
|
$_frozen
Panes are frozen? (in sheet currently being read). See WINDOW2 record. |
|
private
boolean
|
$_isFitToPages
Fit printout to number of pages? (in sheet currently being read). See SHEETPR record. |
|
private
array
|
$_objs
Objects. One OBJ record contributes with one entry. |
|
private
array
|
$_textObjects
Text Objects. One TXO record corresponds with one entry. |
|
private
array
|
$_cellNotes
Cell Annotations (BIFF8) |
|
private
string
|
$_drawingGroupData
The combined MSODRAWINGGROUP data |
|
private
string
|
$_drawingData
The combined MSODRAWING data (per sheet) |
|
private
integer
|
$_xfIndex
Keep track of XF index |
|
private
array
|
$_mapCellXfIndex
Mapping of XF index (that is a cell XF) to final index in cellXf collection |
|
private
array
|
$_mapCellStyleXfIndex
Mapping of XF index (that is a style XF) to final index in cellStyleXf collection |
|
private
array
|
$_sharedFormulas
The shared formulas in a sheet. One SHAREDFMLA record contributes with one value. |
|
private
array
|
$_sharedFormulaParts
The shared formula parts in a sheet. One FORMULA record contributes with one value if it refers to a shared formula. |
|
private
integer
|
$_encryption
The type of encryption in use |
#
0
|
private
integer
|
$_encryptionStartPos
The position in the stream after which contents are encrypted |
#
false
|
private
|
$_rc4Key
The current RC4 decryption object |
#
null
|
private
integer
|
$_rc4Pos
The position in the stream that the RC4 decryption object was left at |
#
0
|
private
string
|
$_md5Ctxt
The current MD5 context state |
#
null
|
$_fileHandle,
$_includeCharts,
$_loadSheetsOnly,
$_readDataOnly,
$_readFilter
|