interface IReader (View source)

Methods

__construct()

IReader constructor.

bool
canRead(string $pFilename)

Can the current IReader read the file?

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.

load(string $pFilename)

Loads PhpSpreadsheet from file.

Details

__construct()

IReader constructor.

bool canRead(string $pFilename)

Can the current IReader read the file?

Parameters

string $pFilename

Return Value

bool

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

Spreadsheet load(string $pFilename)

Loads PhpSpreadsheet from file.

Parameters

string $pFilename

Return Value

Spreadsheet

Exceptions

Exception