Documentation

BaseReader implements IReader

Table of Contents

$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. 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. 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;. bool
$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. array
$readFilter IReadFilter instance. IReadFilter
$fileHandle
$securityScanner XmlScanner
__construct() IReader constructor. mixed
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. bool
setReadDataOnly() Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. IReader
getReadEmptyCells() Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value. bool
setReadEmptyCells() Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value. IReader
getIncludeCharts() Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook. bool
setIncludeCharts() Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. IReader
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. mixed
setLoadSheetsOnly() Set which sheets to load. IReader
setLoadAllSheets() Set all sheets to load Tells the Reader to load all worksheets from the workbook. IReader
getReadFilter() Read filter. IReadFilter
setReadFilter() Set read filter. IReader
getSecurityScanner() mixed
openFile() Open file for reading. void

Properties

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

protected bool $readDataOnly = false

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

protected bool $readEmptyCells = true

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

protected bool $includeCharts = false

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

protected array $loadSheetsOnly

Methods

__construct()

IReader constructor.

public __construct( ) : mixed
Return values
mixed

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.

public getReadDataOnly( ) : bool

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

Return values
bool

setReadDataOnly()

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

public setReadDataOnly( $pValue : mixed ) : IReader

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

Parameters
$pValue : mixed
Return values
IReader

getReadEmptyCells()

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

public getReadEmptyCells( ) : bool

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

Return values
bool

setReadEmptyCells()

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

public setReadEmptyCells( $pValue : mixed ) : IReader

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

Parameters
$pValue : mixed
Return values
IReader

getIncludeCharts()

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

public getIncludeCharts( ) : bool

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 values
bool

setIncludeCharts()

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

public setIncludeCharts( $pValue : mixed ) : IReader

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
$pValue : mixed
Return values
IReader

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.

public getLoadSheetsOnly( ) : mixed
Return values
mixed

setLoadSheetsOnly()

Set which sheets to load.

public setLoadSheetsOnly( $value : mixed ) : IReader
Parameters
$value : mixed

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 values
IReader

setLoadAllSheets()

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

public setLoadAllSheets( ) : IReader
Return values
IReader

getSecurityScanner()

public getSecurityScanner( ) : mixed
Return values
mixed

openFile()

Open file for reading.

protected openFile( $pFilename : string ) : void
Parameters
$pFilename : string

Search results