class Xls extends BaseReader (View source)

Constants

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

Properties

protected bool $readDataOnly 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. from BaseReader
protected bool $readEmptyCells Read empty cells? Identifies whether the Reader should read data values for cells all cells, or should ignore cells containing null value or empty string. from BaseReader
protected bool $includeCharts Read charts that are defined in the workbook? Identifies whether the Reader should read the definitions for any charts that exist in the workbook;. from BaseReader
protected array $loadSheetsOnly 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. from BaseReader
protected IReadFilter $readFilter IReadFilter instance. from BaseReader
protected $fileHandle from BaseReader
protected XmlScanner $securityScanner from BaseReader

Methods

bool
getReadDataOnly()

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

setReadDataOnly(bool $pValue)

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

bool
getReadEmptyCells()

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

setReadEmptyCells(bool $pValue)

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

bool
getIncludeCharts()

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

setIncludeCharts(bool $pValue)

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

mixed
getLoadSheetsOnly()

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.

setLoadSheetsOnly(mixed $value)

Set which sheets to load.

setLoadAllSheets()

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

getReadFilter()

Read filter.

setReadFilter(IReadFilter $pValue)

Set read filter.

getSecuritySCanner()

No description

openFile(string $pFilename)

Open file for reading.

__construct()

Create a new Xls Reader instance.

bool
canRead(string $pFilename)

Can the current IReader read the file?

array
listWorksheetNames(string $pFilename)

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

array
listWorksheetInfo(string $pFilename)

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

load(string $pFilename)

Loads PhpSpreadsheet from file.

static int
getUInt2d(string $data, int $pos)

Read 16-bit unsigned integer.

static int
getInt2d(string $data, int $pos)

Read 16-bit signed integer.

static int
getInt4d(string $data, int $pos)

Read 32-bit signed integer.

Details

bool getReadDataOnly()

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.

Return Value

bool

IReader setReadDataOnly(bool $pValue)

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

bool $pValue

Return Value

IReader

bool getReadEmptyCells()

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

If false it will not read data for cells containing a null value or an empty string.

Return Value

bool

IReader setReadEmptyCells(bool $pValue)

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

Set to false to advise the Reader to ignore cells containing a null value or an empty string.

Parameters

bool $pValue

Return Value

IReader

bool getIncludeCharts()

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.

Return Value

bool

IReader setIncludeCharts(bool $pValue)

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

bool $pValue

Return Value

IReader

mixed getLoadSheetsOnly()

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.

Return Value

mixed

IReader setLoadSheetsOnly(mixed $value)

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

Return Value

IReader

IReader setLoadAllSheets()

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

Return Value

IReader

IReadFilter getReadFilter()

Read filter.

Return Value

IReadFilter

IReader setReadFilter(IReadFilter $pValue)

Set read filter.

Parameters

IReadFilter $pValue

Return Value

IReader

getSecuritySCanner()

protected openFile(string $pFilename)

Open file for reading.

Parameters

string $pFilename

Exceptions

Exception

__construct()

Create a new Xls Reader instance.

bool canRead(string $pFilename)

Can the current IReader read the file?

Parameters

string $pFilename

Return Value

bool

array listWorksheetNames(string $pFilename)

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

Parameters

string $pFilename

Return Value

array

Exceptions

Exception

array listWorksheetInfo(string $pFilename)

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

Parameters

string $pFilename

Return Value

array

Exceptions

Exception

Spreadsheet load(string $pFilename)

Loads PhpSpreadsheet from file.

Parameters

string $pFilename

Return Value

Spreadsheet

Exceptions

Exception

static int getUInt2d(string $data, int $pos)

Read 16-bit unsigned integer.

Parameters

string $data
int $pos

Return Value

int

static int getInt2d(string $data, int $pos)

Read 16-bit signed integer.

Parameters

string $data
int $pos

Return Value

int

static int getInt4d(string $data, int $pos)

Read 32-bit signed integer.

Parameters

string $data
int $pos

Return Value

int