Inheritance diagram for PhpOffice\PhpSpreadsheet\Reader\IReader:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Reader\IReader:

Public Member Functions
	__construct ()
	IReader constructor. More...

	canRead ($pFilename)
	Can the current IReader read the file? More...

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

	setReadDataOnly ($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. More...

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

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

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

	setIncludeCharts ($pValue)
	Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. More...

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

	setLoadSheetsOnly ($value)
	Set which sheets to load. More...

	setLoadAllSheets ()
	Set all sheets to load Tells the Reader to load all worksheets from the workbook. More...

	getReadFilter ()
	Read filter. More...

	setReadFilter (IReadFilter $pValue)
	Set read filter. More...

	load ($pFilename)
	Loads PhpSpreadsheet from file. More...

Detailed Description

Definition at line 5 of file IReader.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Reader\IReader::__construct ( )

IReader constructor.

Implemented in PhpOffice\PhpSpreadsheet\Reader\Xls, PhpOffice\PhpSpreadsheet\Reader\Html, PhpOffice\PhpSpreadsheet\Reader\Csv, PhpOffice\PhpSpreadsheet\Reader\Gnumeric, PhpOffice\PhpSpreadsheet\Reader\Slk, PhpOffice\PhpSpreadsheet\Reader\Xlsx, PhpOffice\PhpSpreadsheet\Reader\BaseReader, PhpOffice\PhpSpreadsheet\Reader\Xml, and PhpOffice\PhpSpreadsheet\Reader\Ods.

Member Function Documentation

◆ canRead()

PhpOffice\PhpSpreadsheet\Reader\IReader::canRead ( $pFilename )

Can the current IReader read the file?

Parameters

string $pFilename

Returns: bool

Implemented in PhpOffice\PhpSpreadsheet\Reader\Xls, PhpOffice\PhpSpreadsheet\Reader\Csv, PhpOffice\PhpSpreadsheet\Reader\Html, PhpOffice\PhpSpreadsheet\Reader\Gnumeric, PhpOffice\PhpSpreadsheet\Reader\Xlsx, PhpOffice\PhpSpreadsheet\Reader\Slk, PhpOffice\PhpSpreadsheet\Reader\Xml, and PhpOffice\PhpSpreadsheet\Reader\Ods.

◆ getIncludeCharts()

PhpOffice\PhpSpreadsheet\Reader\IReader::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.

Returns: bool

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ getLoadSheetsOnly()

PhpOffice\PhpSpreadsheet\Reader\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.

Returns: mixed

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ getReadDataOnly()

PhpOffice\PhpSpreadsheet\Reader\IReader::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.

Returns: bool

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ getReadEmptyCells()

PhpOffice\PhpSpreadsheet\Reader\IReader::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.

Returns: bool

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ getReadFilter()

PhpOffice\PhpSpreadsheet\Reader\IReader::getReadFilter ( )

Read filter.

Returns: IReadFilter

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ load()

PhpOffice\PhpSpreadsheet\Reader\IReader::load ( $pFilename )

Loads PhpSpreadsheet from file.

Parameters

string $pFilename

Returns

Implemented in PhpOffice\PhpSpreadsheet\Reader\Xls, PhpOffice\PhpSpreadsheet\Reader\Csv, PhpOffice\PhpSpreadsheet\Reader\Xml, PhpOffice\PhpSpreadsheet\Reader\Gnumeric, PhpOffice\PhpSpreadsheet\Reader\Ods, PhpOffice\PhpSpreadsheet\Reader\Html, and PhpOffice\PhpSpreadsheet\Reader\Slk.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

Here is the caller graph for this function:

◆ setIncludeCharts()

PhpOffice\PhpSpreadsheet\Reader\IReader::setIncludeCharts ( $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

Returns: IReader

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ setLoadAllSheets()

PhpOffice\PhpSpreadsheet\Reader\IReader::setLoadAllSheets ( )

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

Returns: IReader

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ setLoadSheetsOnly()

PhpOffice\PhpSpreadsheet\Reader\IReader::setLoadSheetsOnly ( $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

Returns: IReader

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ setReadDataOnly()

PhpOffice\PhpSpreadsheet\Reader\IReader::setReadDataOnly ( $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

Returns: IReader

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ setReadEmptyCells()

PhpOffice\PhpSpreadsheet\Reader\IReader::setReadEmptyCells ( $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

Returns: IReader

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

◆ setReadFilter()

PhpOffice\PhpSpreadsheet\Reader\IReader::setReadFilter ( IReadFilter $pValue )

Set read filter.

Returns: IReader

Implemented in PhpOffice\PhpSpreadsheet\Reader\BaseReader.

The documentation for this interface was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Reader/IReader.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canRead()

◆ getIncludeCharts()

◆ getLoadSheetsOnly()

◆ getReadDataOnly()

◆ getReadEmptyCells()

◆ getReadFilter()

◆ load()

◆ setIncludeCharts()

◆ setLoadAllSheets()

◆ setLoadSheetsOnly()

◆ setReadDataOnly()

◆ setReadEmptyCells()

◆ setReadFilter()