\PHPExcel_Reader_Excel5

PHPExcel_Reader_Excel5

This class uses http://sourceforge.net/projects/phpexcelreader/parseXL

Summary

Methods
Properties
Constants
getReadDataOnly()
setReadDataOnly()
getIncludeCharts()
setIncludeCharts()
getLoadSheetsOnly()
setLoadSheetsOnly()
setLoadAllSheets()
getReadFilter()
setReadFilter()
canRead()
securityScan()
securityScanFile()
__construct()
listWorksheetNames()
listWorksheetInfo()
load()
_GetInt2d()
_GetInt4d()
No public properties found
XLS_BIFF8
XLS_BIFF7
XLS_WorkbookGlobals
XLS_Worksheet
XLS_Type_FORMULA
XLS_Type_EOF
XLS_Type_PROTECT
XLS_Type_OBJECTPROTECT
XLS_Type_SCENPROTECT
XLS_Type_PASSWORD
XLS_Type_HEADER
XLS_Type_FOOTER
XLS_Type_EXTERNSHEET
XLS_Type_DEFINEDNAME
XLS_Type_VERTICALPAGEBREAKS
XLS_Type_HORIZONTALPAGEBREAKS
XLS_Type_NOTE
XLS_Type_SELECTION
XLS_Type_DATEMODE
XLS_Type_EXTERNNAME
XLS_Type_LEFTMARGIN
XLS_Type_RIGHTMARGIN
XLS_Type_TOPMARGIN
XLS_Type_BOTTOMMARGIN
XLS_Type_PRINTGRIDLINES
XLS_Type_FILEPASS
XLS_Type_FONT
XLS_Type_CONTINUE
XLS_Type_PANE
XLS_Type_CODEPAGE
XLS_Type_DEFCOLWIDTH
XLS_Type_OBJ
XLS_Type_COLINFO
XLS_Type_IMDATA
XLS_Type_SHEETPR
XLS_Type_HCENTER
XLS_Type_VCENTER
XLS_Type_SHEET
XLS_Type_PALETTE
XLS_Type_SCL
XLS_Type_PAGESETUP
XLS_Type_MULRK
XLS_Type_MULBLANK
XLS_Type_DBCELL
XLS_Type_XF
XLS_Type_MERGEDCELLS
XLS_Type_MSODRAWINGGROUP
XLS_Type_MSODRAWING
XLS_Type_SST
XLS_Type_LABELSST
XLS_Type_EXTSST
XLS_Type_EXTERNALBOOK
XLS_Type_DATAVALIDATIONS
XLS_Type_TXO
XLS_Type_HYPERLINK
XLS_Type_DATAVALIDATION
XLS_Type_DIMENSION
XLS_Type_BLANK
XLS_Type_NUMBER
XLS_Type_LABEL
XLS_Type_BOOLERR
XLS_Type_STRING
XLS_Type_ROW
XLS_Type_INDEX
XLS_Type_ARRAY
XLS_Type_DEFAULTROWHEIGHT
XLS_Type_WINDOW2
XLS_Type_RK
XLS_Type_STYLE
XLS_Type_FORMAT
XLS_Type_SHAREDFMLA
XLS_Type_BOF
XLS_Type_SHEETPROTECTION
XLS_Type_RANGEPROTECTION
XLS_Type_SHEETLAYOUT
XLS_Type_XFEXT
XLS_Type_PAGELAYOUTVIEW
XLS_Type_UNKNOWN
MS_BIFF_CRYPTO_NONE
MS_BIFF_CRYPTO_XOR
MS_BIFF_CRYPTO_RC4
REKEY_BLOCK
_openFile()
$_readDataOnly
$_includeCharts
$_loadSheetsOnly
$_readFilter
$_fileHandle
N/A
_readRecordData()
_loadOLE()
_readSummaryInformation()
_readDocumentSummaryInformation()
_readDefault()
_readNote()
_readTextObject()
_readBof()
_readFilepass()
_makeKey()
_verifyPassword()
_readCodepage()
_readDateMode()
_readFont()
_readFormat()
_readXf()
_readXfExt()
_readStyle()
_readPalette()
_readSheet()
_readExternalBook()
_readExternName()
_readExternSheet()
_readDefinedName()
_readMsoDrawingGroup()
_readSst()
_readPrintGridlines()
_readDefaultRowHeight()
_readSheetPr()
_readHorizontalPageBreaks()
_readVerticalPageBreaks()
_readHeader()
_readFooter()
_readHcenter()
_readVcenter()
_readLeftMargin()
_readRightMargin()
_readTopMargin()
_readBottomMargin()
_readPageSetup()
_readProtect()
_readScenProtect()
_readObjectProtect()
_readPassword()
_readDefColWidth()
_readColInfo()
_readRow()
_readRk()
_readLabelSst()
_readMulRk()
_readNumber()
_readFormula()
_readSharedFmla()
_readString()
_readBoolErr()
_readMulBlank()
_readLabel()
_readBlank()
_readMsoDrawing()
_readObj()
_readWindow2()
_readPageLayoutView()
_readScl()
_readPane()
_readSelection()
_includeCellRangeFiltered()
_readMergedCells()
_readHyperLink()
_readDataValidations()
_readDataValidation()
_readSheetLayout()
_readSheetProtection()
_readRangeProtection()
_readImData()
_readContinue()
_getSplicedRecordData()
_getFormulaFromStructure()
_getFormulaFromData()
_createFormulaFromTokens()
_getNextToken()
_readBIFF8CellAddress()
_readBIFF8CellAddressB()
_readBIFF5CellRangeAddressFixed()
_readBIFF8CellRangeAddressFixed()
_readBIFF8CellRangeAddress()
_readBIFF8CellRangeAddressB()
_readBIFF8CellRangeAddressList()
_readBIFF5CellRangeAddressList()
_readSheetRangeByRefIndex()
_readBIFF8ConstantArray()
_readBIFF8Constant()
_readRGB()
_readByteStringShort()
_readByteStringLong()
_readUnicodeStringShort()
_readUnicodeStringLong()
_readUnicodeString()
_UTF8toExcelDoubleQuoted()
_extractNumber()
_GetIEEE754()
_encodeUTF16()
_uncompressByteString()
_decodeCodepage()
_readColor()
_mapBorderStyle()
_mapFillPattern()
_mapErrorCode()
_mapBuiltInColor()
_mapColorBIFF5()
_mapColor()
_parseRichText()
$_summaryInformation
$_documentSummaryInformation
$_userDefinedProperties
$_data
$_dataSize
$_pos
$_phpExcel
$_phpSheet
$_version
$_codepage
$_formats
$_objFonts
$_palette
$_sheets
$_externalBooks
$_ref
$_externalNames
$_definedname
$_sst
$_frozen
$_isFitToPages
$_objs
$_textObjects
$_cellNotes
$_drawingGroupData
$_drawingData
$_xfIndex
$_mapCellXfIndex
$_mapCellStyleXfIndex
$_sharedFormulas
$_sharedFormulaParts
$_encryption
$_encryptionStartPos
$_rc4Key
$_rc4Pos
$_md5Ctxt
N/A

Constants

XLS_BIFF8

XLS_BIFF8 = 1536

XLS_BIFF7

XLS_BIFF7 = 1280

XLS_WorkbookGlobals

XLS_WorkbookGlobals = 5

XLS_Worksheet

XLS_Worksheet = 16

XLS_Type_FORMULA

XLS_Type_FORMULA = 6

XLS_Type_EOF

XLS_Type_EOF = 10

XLS_Type_PROTECT

XLS_Type_PROTECT = 18

XLS_Type_OBJECTPROTECT

XLS_Type_OBJECTPROTECT = 99

XLS_Type_SCENPROTECT

XLS_Type_SCENPROTECT = 221

XLS_Type_PASSWORD

XLS_Type_PASSWORD = 19

XLS_Type_HEADER

XLS_Type_HEADER = 20

XLS_Type_EXTERNSHEET

XLS_Type_EXTERNSHEET = 23

XLS_Type_DEFINEDNAME

XLS_Type_DEFINEDNAME = 24

XLS_Type_VERTICALPAGEBREAKS

XLS_Type_VERTICALPAGEBREAKS = 26

XLS_Type_HORIZONTALPAGEBREAKS

XLS_Type_HORIZONTALPAGEBREAKS = 27

XLS_Type_NOTE

XLS_Type_NOTE = 28

XLS_Type_SELECTION

XLS_Type_SELECTION = 29

XLS_Type_DATEMODE

XLS_Type_DATEMODE = 34

XLS_Type_EXTERNNAME

XLS_Type_EXTERNNAME = 35

XLS_Type_LEFTMARGIN

XLS_Type_LEFTMARGIN = 38

XLS_Type_RIGHTMARGIN

XLS_Type_RIGHTMARGIN = 39

XLS_Type_TOPMARGIN

XLS_Type_TOPMARGIN = 40

XLS_Type_BOTTOMMARGIN

XLS_Type_BOTTOMMARGIN = 41

XLS_Type_PRINTGRIDLINES

XLS_Type_PRINTGRIDLINES = 43

XLS_Type_FILEPASS

XLS_Type_FILEPASS = 47

XLS_Type_FONT

XLS_Type_FONT = 49

XLS_Type_CONTINUE

XLS_Type_CONTINUE = 60

XLS_Type_PANE

XLS_Type_PANE = 65

XLS_Type_CODEPAGE

XLS_Type_CODEPAGE = 66

XLS_Type_DEFCOLWIDTH

XLS_Type_DEFCOLWIDTH = 85

XLS_Type_OBJ

XLS_Type_OBJ = 93

XLS_Type_COLINFO

XLS_Type_COLINFO = 125

XLS_Type_IMDATA

XLS_Type_IMDATA = 127

XLS_Type_SHEETPR

XLS_Type_SHEETPR = 129

XLS_Type_HCENTER

XLS_Type_HCENTER = 131

XLS_Type_VCENTER

XLS_Type_VCENTER = 132

XLS_Type_SHEET

XLS_Type_SHEET = 133

XLS_Type_PALETTE

XLS_Type_PALETTE = 146

XLS_Type_SCL

XLS_Type_SCL = 160

XLS_Type_PAGESETUP

XLS_Type_PAGESETUP = 161

XLS_Type_MULRK

XLS_Type_MULRK = 189

XLS_Type_MULBLANK

XLS_Type_MULBLANK = 190

XLS_Type_DBCELL

XLS_Type_DBCELL = 215

XLS_Type_XF

XLS_Type_XF = 224

XLS_Type_MERGEDCELLS

XLS_Type_MERGEDCELLS = 229

XLS_Type_MSODRAWINGGROUP

XLS_Type_MSODRAWINGGROUP = 235

XLS_Type_MSODRAWING

XLS_Type_MSODRAWING = 236

XLS_Type_SST

XLS_Type_SST = 252

XLS_Type_LABELSST

XLS_Type_LABELSST = 253

XLS_Type_EXTSST

XLS_Type_EXTSST = 255

XLS_Type_EXTERNALBOOK

XLS_Type_EXTERNALBOOK = 430

XLS_Type_DATAVALIDATIONS

XLS_Type_DATAVALIDATIONS = 434

XLS_Type_TXO

XLS_Type_TXO = 438

XLS_Type_DATAVALIDATION

XLS_Type_DATAVALIDATION = 446

XLS_Type_DIMENSION

XLS_Type_DIMENSION = 512

XLS_Type_BLANK

XLS_Type_BLANK = 513

XLS_Type_NUMBER

XLS_Type_NUMBER = 515

XLS_Type_LABEL

XLS_Type_LABEL = 516

XLS_Type_BOOLERR

XLS_Type_BOOLERR = 517

XLS_Type_STRING

XLS_Type_STRING = 519

XLS_Type_ROW

XLS_Type_ROW = 520

XLS_Type_INDEX

XLS_Type_INDEX = 523

XLS_Type_ARRAY

XLS_Type_ARRAY = 545

XLS_Type_DEFAULTROWHEIGHT

XLS_Type_DEFAULTROWHEIGHT = 549

XLS_Type_WINDOW2

XLS_Type_WINDOW2 = 574

XLS_Type_RK

XLS_Type_RK = 638

XLS_Type_STYLE

XLS_Type_STYLE = 659

XLS_Type_FORMAT

XLS_Type_FORMAT = 1054

XLS_Type_SHAREDFMLA

XLS_Type_SHAREDFMLA = 1212

XLS_Type_BOF

XLS_Type_BOF = 2057

XLS_Type_SHEETPROTECTION

XLS_Type_SHEETPROTECTION = 2151

XLS_Type_RANGEPROTECTION

XLS_Type_RANGEPROTECTION = 2152

XLS_Type_SHEETLAYOUT

XLS_Type_SHEETLAYOUT = 2146

XLS_Type_XFEXT

XLS_Type_XFEXT = 2173

XLS_Type_PAGELAYOUTVIEW

XLS_Type_PAGELAYOUTVIEW = 2187

XLS_Type_UNKNOWN

XLS_Type_UNKNOWN = 65535

MS_BIFF_CRYPTO_NONE

MS_BIFF_CRYPTO_NONE = 0

MS_BIFF_CRYPTO_XOR

MS_BIFF_CRYPTO_XOR = 1

MS_BIFF_CRYPTO_RC4

MS_BIFF_CRYPTO_RC4 = 2

REKEY_BLOCK

REKEY_BLOCK = 1024

Properties

$_readDataOnly

$_readDataOnly : boolean

Read data only? Identifies whether the Reader should only read data values for cells, and ignore any formatting information; or whether it should read both data and formatting

Type

boolean

$_includeCharts

$_includeCharts : boolean

Read charts that are defined in the workbook? Identifies whether the Reader should read the definitions for any charts that exist in the workbook;

Type

boolean

$_loadSheetsOnly

$_loadSheetsOnly : array

Restrict which sheets should be loaded? This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.

Type

array — of string

$_fileHandle

$_fileHandle : 

Type

$_summaryInformation

$_summaryInformation : string

Summary Information stream data.

Type

string

$_documentSummaryInformation

$_documentSummaryInformation : string

Extended Summary Information stream data.

Type

string

$_userDefinedProperties

$_userDefinedProperties : string

User-Defined Properties stream data.

Type

string

$_data

$_data : string

Workbook stream data. (Includes workbook globals substream as well as sheet substreams)

Type

string

$_dataSize

$_dataSize : integer

Size in bytes of $this->_data

Type

integer

$_pos

$_pos : integer

Current position in stream

Type

integer

$_phpExcel

$_phpExcel : \PHPExcel

Workbook to be returned by the reader.

Type

\PHPExcel

$_phpSheet

$_phpSheet : \PHPExcel_Worksheet

Worksheet that is currently being built by the reader.

Type

\PHPExcel_Worksheet

$_version

$_version : integer

BIFF version

Type

integer

$_codepage

$_codepage : string

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'

Type

string

$_formats

$_formats : array

Shared formats

Type

array

$_objFonts

$_objFonts : array

Shared fonts

Type

array

$_palette

$_palette : array

Color palette

Type

array

$_sheets

$_sheets : array

Worksheets

Type

array

$_externalBooks

$_externalBooks : array

External books

Type

array

$_ref

$_ref : array

REF structures. Only applies to BIFF8.

Type

array

$_externalNames

$_externalNames : array

External names

Type

array

$_definedname

$_definedname : array

Defined names

Type

array

$_sst

$_sst : array

Shared strings. Only applies to BIFF8.

Type

array

$_frozen

$_frozen : boolean

Panes are frozen? (in sheet currently being read). See WINDOW2 record.

Type

boolean

$_isFitToPages

$_isFitToPages : boolean

Fit printout to number of pages? (in sheet currently being read). See SHEETPR record.

Type

boolean

$_objs

$_objs : array

Objects. One OBJ record contributes with one entry.

Type

array

$_textObjects

$_textObjects : array

Text Objects. One TXO record corresponds with one entry.

Type

array

$_cellNotes

$_cellNotes : array

Cell Annotations (BIFF8)

Type

array

$_drawingGroupData

$_drawingGroupData : string

The combined MSODRAWINGGROUP data

Type

string

$_drawingData

$_drawingData : string

The combined MSODRAWING data (per sheet)

Type

string

$_xfIndex

$_xfIndex : integer

Keep track of XF index

Type

integer

$_mapCellXfIndex

$_mapCellXfIndex : array

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

Type

array

$_mapCellStyleXfIndex

$_mapCellStyleXfIndex : array

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

Type

array

$_sharedFormulas

$_sharedFormulas : array

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

Type

array

$_sharedFormulaParts

$_sharedFormulaParts : array

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

Type

array

$_encryption

$_encryption : integer

The type of encryption in use

Type

integer

$_encryptionStartPos

$_encryptionStartPos : integer

The position in the stream after which contents are encrypted

Type

integer

$_rc4Pos

$_rc4Pos : integer

The position in the stream that the RC4 decryption object was left at

Type

integer

$_md5Ctxt

$_md5Ctxt : string

The current MD5 context state

Type

string

Methods

getReadDataOnly()

getReadDataOnly() : boolean

Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information.

If false (the default) it will read data and formatting.

Returns

boolean

setReadDataOnly()

setReadDataOnly(boolean  $pValue = FALSE) : \PHPExcel_Reader_IReader

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.

Set to false (the default) to advise the Reader to read both data and formatting for cells.

Parameters

boolean $pValue

Returns

\PHPExcel_Reader_IReader

getIncludeCharts()

getIncludeCharts() : boolean

Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook.

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.

Returns

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue = FALSE) : \PHPExcel_Reader_IReader

Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook.

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.

Parameters

boolean $pValue

Returns

\PHPExcel_Reader_IReader

getLoadSheetsOnly()

getLoadSheetsOnly() : mixed

Get which sheets to load Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null indicating that all worksheets in the workbook should be loaded.

Returns

mixed

setLoadSheetsOnly()

setLoadSheetsOnly(mixed  $value = NULL) : \PHPExcel_Reader_IReader

Set which sheets to load

Parameters

mixed $value

This 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

Returns

\PHPExcel_Reader_IReader

setLoadAllSheets()

setLoadAllSheets() : \PHPExcel_Reader_IReader

Set all sheets to load Tells the Reader to load all worksheets from the workbook.

Returns

\PHPExcel_Reader_IReader

canRead()

canRead(string  $pFilename) : boolean

Can the current PHPExcel_Reader_IReader read the file?

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

boolean

securityScan()

securityScan(string  $xml) 

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Parameters

string $xml

Throws

\PHPExcel_Reader_Exception

securityScanFile()

securityScanFile(string  $filestream) 

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Parameters

string $filestream

Throws

\PHPExcel_Reader_Exception

__construct()

__construct() 

Create a new PHPExcel_Reader_Excel5 instance

listWorksheetNames()

listWorksheetNames(string  $pFilename) 

Reads names of the worksheets from a file, without parsing the whole file to a PHPExcel object

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

listWorksheetInfo()

listWorksheetInfo(string  $pFilename) 

Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns)

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

load()

load(string  $pFilename) : \PHPExcel

Loads PHPExcel from file

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

\PHPExcel

_GetInt2d()

_GetInt2d(string  $data, integer  $pos) : integer

Read 16-bit unsigned integer

Parameters

string $data
integer $pos

Returns

integer

_GetInt4d()

_GetInt4d(string  $data, integer  $pos) : integer

Read 32-bit signed integer

Parameters

string $data
integer $pos

Returns

integer

_openFile()

_openFile(string  $pFilename) : resource

Open file for reading

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

resource

_readRecordData()

_readRecordData(string  $data, integer  $pos,   $len) : string

Read record data from stream, decrypting as required

Parameters

string $data

Data stream to read from

integer $pos

Position to start reading from

$len

Returns

string —

Record data

_loadOLE()

_loadOLE(string  $pFilename) 

Use OLE reader to extract the relevant data streams from the OLE file

Parameters

string $pFilename

_readSummaryInformation()

_readSummaryInformation() 

Read summary information

_readDocumentSummaryInformation()

_readDocumentSummaryInformation() 

Read additional document summary information

_readDefault()

_readDefault() 

Reads a general type of BIFF record. Does nothing except for moving stream pointer forward to next record.

_readNote()

_readNote() 

The NOTE record specifies a comment associated with a particular cell. In Excel 95 (BIFF7) and earlier versions, this record stores a note (cell note). This feature was significantly enhanced in Excel 97.

_readTextObject()

_readTextObject() 

The TEXT Object record contains the text associated with a cell annotation.

_readBof()

_readBof() 

Read BOF

_readFilepass()

_readFilepass() 

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"

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/

_makeKey()

_makeKey(  $block,   $valContext) : \PHPExcel_Reader_Excel5_RC4

Make an RC4 decryptor for the given block

Parameters

$block
$valContext

Returns

\PHPExcel_Reader_Excel5_RC4

_verifyPassword()

_verifyPassword(  $password,   $docid,   $salt_data,   $hashedsalt_data,   $valContext) : boolean

Verify RC4 file password

Parameters

$password
$docid
$salt_data
$hashedsalt_data
$valContext

Returns

boolean —

Success

_readCodepage()

_readCodepage() 

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"

_readDateMode()

_readDateMode() 

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"

_readFont()

_readFont() 

Read a FONT record

_readFormat()

_readFormat() 

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"

_readXf()

_readXf() 

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"

_readXfExt()

_readXfExt() 

_readStyle()

_readStyle() 

Read STYLE record

_readPalette()

_readPalette() 

Read PALETTE record

_readSheet()

_readSheet() 

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"

_readExternalBook()

_readExternalBook() 

Read EXTERNALBOOK record

_readExternName()

_readExternName() 

Read EXTERNNAME record.

_readExternSheet()

_readExternSheet() 

Read EXTERNSHEET record

_readDefinedName()

_readDefinedName() 

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"

_readMsoDrawingGroup()

_readMsoDrawingGroup() 

Read MSODRAWINGGROUP record

_readSst()

_readSst() 

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"

_readPrintGridlines()

_readPrintGridlines() 

Read PRINTGRIDLINES record

_readDefaultRowHeight()

_readDefaultRowHeight() 

Read DEFAULTROWHEIGHT record

_readSheetPr()

_readSheetPr() 

Read SHEETPR record

_readHorizontalPageBreaks()

_readHorizontalPageBreaks() 

Read HORIZONTALPAGEBREAKS record

_readVerticalPageBreaks()

_readVerticalPageBreaks() 

Read VERTICALPAGEBREAKS record

_readHeader()

_readHeader() 

Read HEADER record

_readFooter()

_readFooter() 

Read FOOTER record

_readHcenter()

_readHcenter() 

Read HCENTER record

_readVcenter()

_readVcenter() 

Read VCENTER record

_readLeftMargin()

_readLeftMargin() 

Read LEFTMARGIN record

_readRightMargin()

_readRightMargin() 

Read RIGHTMARGIN record

_readTopMargin()

_readTopMargin() 

Read TOPMARGIN record

_readBottomMargin()

_readBottomMargin() 

Read BOTTOMMARGIN record

_readPageSetup()

_readPageSetup() 

Read PAGESETUP record

_readProtect()

_readProtect() 

PROTECT - Sheet protection (BIFF2 through BIFF8) if this record is omitted, then it also means no sheet protection

_readScenProtect()

_readScenProtect() 

SCENPROTECT

_readObjectProtect()

_readObjectProtect() 

OBJECTPROTECT

_readPassword()

_readPassword() 

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

_readDefColWidth()

_readDefColWidth() 

Read DEFCOLWIDTH record

_readColInfo()

_readColInfo() 

Read COLINFO record

_readRow()

_readRow() 

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"

_readRk()

_readRk() 

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"

_readLabelSst()

_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.

-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

_readMulRk()

_readMulRk() 

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"

_readNumber()

_readNumber() 

Read NUMBER record This record represents a cell that contains a floating-point value.

-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

_readFormula()

_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.

-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

_readSharedFmla()

_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.

_readString()

_readString() : string

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

Returns

string —

The string contents as UTF-8

_readBoolErr()

_readBoolErr() 

Read BOOLERR record This record represents a Boolean value or error value cell.

-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

_readMulBlank()

_readMulBlank() 

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"

_readLabel()

_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.

-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

_readBlank()

_readBlank() 

Read BLANK record

_readMsoDrawing()

_readMsoDrawing() 

Read MSODRAWING record

_readObj()

_readObj() 

Read OBJ record

_readWindow2()

_readWindow2() 

Read WINDOW2 record

_readPageLayoutView()

_readPageLayoutView() 

Read PLV Record(Created by Excel2007 or upper)

_readScl()

_readScl() 

Read SCL record

_readPane()

_readPane() 

Read PANE record

_readSelection()

_readSelection() 

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

_includeCellRangeFiltered()

_includeCellRangeFiltered(  $cellRangeAddress) 

Parameters

$cellRangeAddress

_readMergedCells()

_readMergedCells() 

MERGEDCELLS

This record contains the addresses of merged cell ranges in the current sheet.

-- "OpenOffice.org's Documentation of the Microsoft Excel File Format"

_readHyperLink()

_readHyperLink() 

Read HYPERLINK record

_readDataValidations()

_readDataValidations() 

Read DATAVALIDATIONS record

_readDataValidation()

_readDataValidation() 

Read DATAVALIDATION record

_readSheetLayout()

_readSheetLayout() 

Read SHEETLAYOUT record. Stores sheet tab color information.

_readSheetProtection()

_readSheetProtection() 

Read SHEETPROTECTION record (FEATHEADR)

_readRangeProtection()

_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

_readImData()

_readImData() 

Read IMDATA record

_readContinue()

_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

_getSplicedRecordData()

_getSplicedRecordData() : array

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

Returns

array

_getFormulaFromStructure()

_getFormulaFromStructure(string  $formulaStructure, string  $baseCell = 'A1') : string

Convert formula structure into human readable Excel formula like 'A3+A5*5'

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

Returns

string —

Human readable formula

_getFormulaFromData()

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

Take formula data and additional data for formula and return human readable formula

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

Returns

string —

Human readable formula

_createFormulaFromTokens()

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

Take array of tokens together with additional data for formula and return human readable formula

Parameters

array $tokens
array $additionalData

Additional binary data going with the formula

Returns

string —

Human readable formula

_getNextToken()

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

Fetch next token from binary formula data

Parameters

$formulaData
string $baseCell

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

Throws

\PHPExcel_Reader_Exception

Returns

array

_readBIFF8CellAddress()

_readBIFF8CellAddress(string  $cellAddressStructure) : string

Reads a cell address in BIFF8 e.g. 'A2' or '$A$2' section 3.3.4

Parameters

string $cellAddressStructure

Returns

string

_readBIFF8CellAddressB()

_readBIFF8CellAddressB(string  $cellAddressStructure, string  $baseCell = 'A1') : string

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

Parameters

string $cellAddressStructure
string $baseCell

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

Returns

string

_readBIFF5CellRangeAddressFixed()

_readBIFF5CellRangeAddressFixed(string  $subData) : string

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

Parameters

string $subData

Throws

\PHPExcel_Reader_Exception

Returns

string

_readBIFF8CellRangeAddressFixed()

_readBIFF8CellRangeAddressFixed(string  $subData) : string

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

Parameters

string $subData

Throws

\PHPExcel_Reader_Exception

Returns

string

_readBIFF8CellRangeAddress()

_readBIFF8CellRangeAddress(string  $subData) : string

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

Parameters

string $subData

Returns

string

_readBIFF8CellRangeAddressB()

_readBIFF8CellRangeAddressB(string  $subData, string  $baseCell = 'A1') : string

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

Parameters

string $subData
string $baseCell

Base cell

Returns

string —

Cell range address

_readBIFF8CellRangeAddressList()

_readBIFF8CellRangeAddressList(string  $subData) : array

Read BIFF8 cell range address list section 2.5.15

Parameters

string $subData

Returns

array

_readBIFF5CellRangeAddressList()

_readBIFF5CellRangeAddressList(string  $subData) : array

Read BIFF5 cell range address list section 2.5.15

Parameters

string $subData

Returns

array

_readSheetRangeByRefIndex()

_readSheetRangeByRefIndex(integer  $index) : string|false

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

Parameters

integer $index

Throws

\PHPExcel_Reader_Exception

Returns

string|false

_readBIFF8ConstantArray()

_readBIFF8ConstantArray(string  $arrayData) : array

read BIFF8 constant value array from array data returns e.g. array('value' => '{1,2;3,4}', 'size' => 40} section 2.5.8

Parameters

string $arrayData

Returns

array

_readBIFF8Constant()

_readBIFF8Constant(string  $valueData) : array

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)

Parameters

string $valueData

Returns

array

_readRGB()

_readRGB(string  $rgb) : array

Extract RGB color OpenOffice.org's Documentation of the Microsoft Excel File Format, section 2.5.4

Parameters

string $rgb

Encoded RGB value (4 bytes)

Returns

array

_readByteStringShort()

_readByteStringShort(string  $subData) : array

Read byte string (8-bit string length) OpenOffice documentation: 2.5.2

Parameters

string $subData

Returns

array

_readByteStringLong()

_readByteStringLong(string  $subData) : array

Read byte string (16-bit string length) OpenOffice documentation: 2.5.2

Parameters

string $subData

Returns

array

_readUnicodeStringShort()

_readUnicodeStringShort(string  $subData) : array

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.

Parameters

string $subData

Returns

array

_readUnicodeStringLong()

_readUnicodeStringLong(string  $subData) : array

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

Parameters

string $subData

Returns

array

_readUnicodeString()

_readUnicodeString(string  $subData, integer  $characterCount) : array

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

Parameters

string $subData
integer $characterCount

Returns

array

_UTF8toExcelDoubleQuoted()

_UTF8toExcelDoubleQuoted(string  $value) : string

Convert UTF-8 string to string surounded by double quotes. Used for explicit string tokens in formulas.

Example: hello"world --> "hello""world"

Parameters

string $value

UTF-8 encoded string

Returns

string

_extractNumber()

_extractNumber(string  $data) : float

Reads first 8 bytes of a string and return IEEE 754 float

Parameters

string $data

Binary string that is at least 8 bytes long

Returns

float

_GetIEEE754()

_GetIEEE754(  $rknum) 

Parameters

$rknum

_encodeUTF16()

_encodeUTF16(string  $string, boolean  $compressed = '') : string

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

Parameters

string $string
boolean $compressed

Returns

string

_uncompressByteString()

_uncompressByteString(string  $string) : string

Convert UTF-16 string in compressed notation to uncompressed form. Only used for BIFF8.

Parameters

string $string

Returns

string

_decodeCodepage()

_decodeCodepage(string  $string) : string

Convert string to UTF-8. Only used for BIFF5.

Parameters

string $string

Returns

string

_readColor()

_readColor(integer  $color, array  $palette,   $version) : array

Read color

Parameters

integer $color

Indexed color

array $palette

Color palette

$version

Returns

array —

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

_mapBorderStyle()

_mapBorderStyle(integer  $index) : string

Map border style OpenOffice documentation: 2.5.11

Parameters

integer $index

Returns

string

_mapFillPattern()

_mapFillPattern(integer  $index) : string

Get fill pattern from index OpenOffice documentation: 2.5.12

Parameters

integer $index

Returns

string

_mapErrorCode()

_mapErrorCode(integer  $subData) : string

Map error code, e.g. '#N/A'

Parameters

integer $subData

Returns

string

_mapBuiltInColor()

_mapBuiltInColor(integer  $color) : array

Map built-in color to RGB value

Parameters

integer $color

Indexed color

Returns

array

_mapColorBIFF5()

_mapColorBIFF5(integer  $subData) : array

Map color array from BIFF5 built-in color index

Parameters

integer $subData

Returns

array

_mapColor()

_mapColor(integer  $subData) : array

Map color array from BIFF8 built-in color index

Parameters

integer $subData

Returns

array

_parseRichText()

_parseRichText(  $is = '') 

Parameters

$is