Properties

$_readDataOnly

$_readDataOnly : boolean

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

Type

boolean

$_includeCharts

$_includeCharts : boolean

Read charts that are defined in the workbook? Identifies whether the Reader should read the definitions for any charts that exist in the workbook;

Type

boolean

$_loadSheetsOnly

$_loadSheetsOnly : array

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.

Type

array — of string

$_fileHandle

$_fileHandle : 

Type

$_inputEncoding

$_inputEncoding : string

Input encoding

Type

string

$_sheetIndex

$_sheetIndex : integer

Sheet index to read

Type

integer

$_formats

$_formats : array

Formats

Type

array

$rowspan

$rowspan : 

Type

$_dataArray

$_dataArray : 

Type

$_tableLevel

$_tableLevel : 

Type

$_nestedColumn

$_nestedColumn : 

Type

Methods

getReadDataOnly()

getReadDataOnly() : boolean

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

boolean

setReadDataOnly()

setReadDataOnly(boolean  $pValue = FALSE) : \PHPExcel_Reader_IReader

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

Returns

\PHPExcel_Reader_IReader

getIncludeCharts()

getIncludeCharts() : boolean

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

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue = FALSE) : \PHPExcel_Reader_IReader

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

Returns

\PHPExcel_Reader_IReader

getLoadSheetsOnly()

getLoadSheetsOnly() : mixed

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

setLoadSheetsOnly()

setLoadSheetsOnly(mixed  $value = NULL) : \PHPExcel_Reader_IReader

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

\PHPExcel_Reader_IReader

setLoadAllSheets()

setLoadAllSheets() : \PHPExcel_Reader_IReader

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

Returns

\PHPExcel_Reader_IReader

canRead()

canRead(string  $pFilename) : boolean

Can the current PHPExcel_Reader_IReader read the file?

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

boolean

securityScan()

securityScan(string  $xml) 

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

Parameters

string $xml

Throws

\PHPExcel_Reader_Exception

securityScanFile()

securityScanFile(string  $filestream) 

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

Parameters

string $filestream

Throws

\PHPExcel_Reader_Exception

__construct()

__construct() 

Create a new PHPExcel_Reader_HTML

load()

load(string  $pFilename) : \PHPExcel

Loads PHPExcel from file

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

\PHPExcel

setInputEncoding()

setInputEncoding(string  $pValue = 'ANSI') 

Set input encoding

Parameters

string $pValue

Input encoding

getInputEncoding()

getInputEncoding() : string

Get input encoding

Returns

string

loadIntoExisting()

loadIntoExisting(string  $pFilename, \PHPExcel  $objPHPExcel) : \PHPExcel

Loads PHPExcel from file into PHPExcel instance

Parameters

string $pFilename
\PHPExcel $objPHPExcel

Throws

\PHPExcel_Reader_Exception

Returns

\PHPExcel

getSheetIndex()

getSheetIndex() : integer

Get sheet index

Returns

integer

setSheetIndex()

setSheetIndex(integer  $pValue) : \PHPExcel_Reader_HTML

Set sheet index

Parameters

integer $pValue

Sheet index

Returns

\PHPExcel_Reader_HTML

_openFile()

_openFile(string  $pFilename) : resource

Open file for reading

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

resource

_isValidFormat()

_isValidFormat() : boolean

Validate that the current file is an HTML file

Returns

boolean

_setTableStartColumn()

_setTableStartColumn(  $column) 

Parameters

$column

_getTableStartColumn()

_getTableStartColumn() 

_releaseTableStartColumn()

_releaseTableStartColumn() 

_flushCell()

_flushCell(  $sheet,   $column,   $row,   $cellContent) 

Parameters

$sheet
$column
$row
$cellContent

_processDomElement()

_processDomElement(\DOMNode  $element,   $sheet,   $row,   $column,   $cellContent,   $format = null) 

Parameters

\DOMNode $element
$sheet
$row
$column
$cellContent
$format