class PHPExcel_Reader_Abstract implements PHPExcel_Reader_IReader

PHPExcelReaderAbstract

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Methods

boolean
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(boolean $pValue = false)

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

boolean
getReadEmptyCells()

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

setReadEmptyCells(boolean $pValue = true)

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

boolean
getIncludeCharts()

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

setIncludeCharts(boolean $pValue = false)

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 = null)

Set which sheets to load

setLoadAllSheets()

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

boolean
canRead(string $pFilename)

Can the current PHPExcelReaderIReader read the file?

securityScan(string $xml)

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

securityScanFile(string $filestream)

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Details

at line 90
boolean 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

boolean

at line 104
PHPExcel_Reader_IReader setReadDataOnly(boolean $pValue = false)

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

boolean $pValue

Return Value

PHPExcel_Reader_IReader

at line 117
boolean 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

boolean

at line 131
PHPExcel_Reader_IReader setReadEmptyCells(boolean $pValue = true)

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

boolean $pValue

Return Value

PHPExcel_Reader_IReader

at line 145
boolean 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

boolean

at line 160
PHPExcel_Reader_IReader setIncludeCharts(boolean $pValue = false)

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

boolean $pValue

Return Value

PHPExcel_Reader_IReader

at line 173
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

at line 187
PHPExcel_Reader_IReader setLoadSheetsOnly(mixed $value = null)

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

PHPExcel_Reader_IReader

at line 203
PHPExcel_Reader_IReader setLoadAllSheets()

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

at line 214
PHPExcel_Reader_IReadFilter getReadFilter()

Read filter

at line 225
PHPExcel_Reader_IReader setReadFilter(PHPExcel_Reader_IReadFilter $pValue)

Set read filter

Parameters

PHPExcel_Reader_IReadFilter $pValue

Return Value

PHPExcel_Reader_IReader

at line 259
boolean canRead(string $pFilename)

Can the current PHPExcelReaderIReader read the file?

Parameters

string $pFilename

Return Value

boolean

Exceptions

PHPExcel_Reader_Exception

at line 279
securityScan(string $xml)

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Parameters

string $xml

Exceptions

PHPExcel_Reader_Exception

at line 294
securityScanFile(string $filestream)

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Parameters

string $filestream

Exceptions

PHPExcel_Reader_Exception