Documentation

XlsBase extends BaseReader

in package

• Application

Table of Contents

Constants

BORDER_STYLE_MAP  = [ \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_NONE, // => 0x00, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THIN, // => 0x01, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUM, // => 0x02, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DASHED, // => 0x03, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DOTTED, // => 0x04, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THICK, // => 0x05, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DOUBLE, // => 0x06, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_HAIR, // => 0x07, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUMDASHED, // => 0x08, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DASHDOT, // => 0x09, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUMDASHDOT, // => 0x0A, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_DASHDOTDOT, // => 0x0B, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_MEDIUMDASHDOTDOT, // => 0x0C, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_SLANTDASHDOT, // => 0x0D, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_OMIT, // => 0x0E, \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_OMIT, ]

MS_BIFF_CRYPTO_NONE  = 0

MS_BIFF_CRYPTO_RC4  = 2

MS_BIFF_CRYPTO_XOR  = 1

REKEY_BLOCK  = 0x400

XLS_BIFF7  = 0x500

XLS_BIFF8  = 0x600

XLS_TYPE_ARRAY  = 0x221

XLS_TYPE_BLANK  = 0x201

XLS_TYPE_BOF  = 0x809

XLS_TYPE_BOOLERR  = 0x205

XLS_TYPE_BOTTOMMARGIN  = 0x29

XLS_TYPE_CFHEADER  = 0x1b0

XLS_TYPE_CFRULE  = 0x1b1

XLS_TYPE_CODEPAGE  = 0x42

XLS_TYPE_COLINFO  = 0x7d

XLS_TYPE_CONTINUE  = 0x3c

XLS_TYPE_DATAVALIDATION  = 0x1be

XLS_TYPE_DATAVALIDATIONS  = 0x1b2

XLS_TYPE_DATEMODE  = 0x22

XLS_TYPE_DBCELL  = 0xd7

XLS_TYPE_DEFAULTROWHEIGHT  = 0x225

XLS_TYPE_DEFCOLWIDTH  = 0x55

XLS_TYPE_DEFINEDNAME  = 0x18

XLS_TYPE_DIMENSION  = 0x200

XLS_TYPE_EOF  = 0xa

XLS_TYPE_EXTERNALBOOK  = 0x1ae

XLS_TYPE_EXTERNNAME  = 0x23

XLS_TYPE_EXTERNSHEET  = 0x17

XLS_TYPE_EXTSST  = 0xff

XLS_TYPE_FILEPASS  = 0x2f

XLS_TYPE_FONT  = 0x31

XLS_TYPE_FOOTER  = 0x15

XLS_TYPE_FORMAT  = 0x41e

XLS_TYPE_FORMULA  = 0x6

XLS_TYPE_HCENTER  = 0x83

XLS_TYPE_HEADER  = 0x14

XLS_TYPE_HORIZONTALPAGEBREAKS  = 0x1b

XLS_TYPE_HYPERLINK  = 0x1b8

XLS_TYPE_IMDATA  = 0x7f

XLS_TYPE_INDEX  = 0x20b

XLS_TYPE_LABEL  = 0x204

XLS_TYPE_LABELSST  = 0xfd

XLS_TYPE_LEFTMARGIN  = 0x26

XLS_TYPE_MERGEDCELLS  = 0xe5

XLS_TYPE_MSODRAWING  = 0xec

XLS_TYPE_MSODRAWINGGROUP  = 0xeb

XLS_TYPE_MULBLANK  = 0xbe

XLS_TYPE_MULRK  = 0xbd

XLS_TYPE_NOTE  = 0x1c

XLS_TYPE_NUMBER  = 0x203

XLS_TYPE_OBJ  = 0x5d

XLS_TYPE_OBJECTPROTECT  = 0x63

XLS_TYPE_PAGELAYOUTVIEW  = 0x88b

XLS_TYPE_PAGESETUP  = 0xa1

XLS_TYPE_PALETTE  = 0x92

XLS_TYPE_PANE  = 0x41

XLS_TYPE_PASSWORD  = 0x13

XLS_TYPE_PRINTGRIDLINES  = 0x2b

XLS_TYPE_PROTECT  = 0x12

XLS_TYPE_RANGEPROTECTION  = 0x868

XLS_TYPE_RIGHTMARGIN  = 0x27

XLS_TYPE_RK  = 0x27e

XLS_TYPE_ROW  = 0x208

XLS_TYPE_SCENPROTECT  = 0xdd

XLS_TYPE_SCL  = 0xa0

XLS_TYPE_SELECTION  = 0x1d

XLS_TYPE_SHAREDFMLA  = 0x4bc

XLS_TYPE_SHEET  = 0x85

XLS_TYPE_SHEETLAYOUT  = 0x862

XLS_TYPE_SHEETPR  = 0x81

XLS_TYPE_SHEETPROTECTION  = 0x867

XLS_TYPE_SST  = 0xfc

XLS_TYPE_STRING  = 0x207

XLS_TYPE_STYLE  = 0x293

XLS_TYPE_TOPMARGIN  = 0x28

XLS_TYPE_TXO  = 0x1b6

XLS_TYPE_UNKNOWN  = 0xffff

XLS_TYPE_VCENTER  = 0x84

XLS_TYPE_VERTICALPAGEBREAKS  = 0x1a

XLS_TYPE_WINDOW2  = 0x23e

XLS_TYPE_XF  = 0xe0

XLS_TYPE_XFEXT  = 0x87d

XLS_WORKBOOKGLOBALS  = 0x5

XLS_WORKSHEET  = 0x10

FC000000  = 0xfc << 24

FE000000  = 0xfe << 24

HIGH_ORDER_BIT  = 0x80 << 24

Properties

$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'.

$fileHandle  : resource

$ignoreRowsWithNoCells  : bool

Ignore rows with no cells? Identifies whether the Reader should ignore rows with no cells.

$includeCharts  : bool

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

$loadSheetsOnly  : null|array<string|int, string>

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.

$readDataOnly  : bool

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.

$readEmptyCells  : bool

Read empty cells? Identifies whether the Reader should read data values for all cells, or should ignore cells containing null value or empty string.

$readFilter  : IReadFilter

IReadFilter instance.

$securityScanner  : XmlScanner|null

$valueBinder  : IValueBinder|null

Methods

__construct()  : mixed

canRead()  : bool

Can the current IReader read the file?

getCodepage()  : string

getIgnoreRowsWithNoCells()  : bool

getIncludeCharts()  : bool

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

getInt2d()  : int

Read 16-bit signed integer.

getInt4d()  : int

Read 32-bit signed integer.

getLoadSheetsOnly()  : array<string|int, mixed>|null

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.

getReadDataOnly()  : bool

Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting or structural information (like merges).

getReadEmptyCells()  : bool

Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value.

getReadFilter()  : IReadFilter

Read filter.

getSecurityScanner()  : XmlScanner|null

getSecurityScannerOrThrow()  : XmlScanner

getUInt2d()  : int

Read 16-bit unsigned integer.

getValueBinder()  : IValueBinder|null

listWorksheetInfo()  : array<string|int, mixed>

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

listWorksheetNames()  : array<string|int, mixed>

Returns names of the worksheets from a file, possibly without parsing the whole file to a Spreadsheet object.

load()  : Spreadsheet

Loads Spreadsheet from file.

setCodepage()  : void

setIgnoreRowsWithNoCells()  : self

setIncludeCharts()  : $this

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

setLoadAllSheets()  : $this

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

setLoadSheetsOnly()  : $this

Set which sheets to load.

setReadDataOnly()  : $this

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting or structural information (like merges).

setReadEmptyCells()  : $this

Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.

setReadFilter()  : $this

Set read filter.

setValueBinder()  : self

decodeCodepage()  : string

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

encodeUTF16()  : string

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

extractNumber()  : int|float

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

getIEEE754()  : float|int

loadSpreadsheetFromFile()  : Spreadsheet

openFile()  : void

Open file for reading.

processFlags()  : void

readRGB()  : array<string|int, mixed>

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

readUnicodeString()  : array<string|int, mixed>

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.

readUnicodeStringLong()  : array<string|int, mixed>

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.

readUnicodeStringShort()  : array<string|int, mixed>

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.

uncompressByteString()  : string

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

UTF8toExcelDoubleQuoted()  : string

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