\PhpOffice\PhpSpreadsheet\ReaderHtml

PhpSpreadsheet root directory

Summary

Methods
Properties
Constants
__construct()
getReadDataOnly()
setReadDataOnly()
getReadEmptyCells()
setReadEmptyCells()
getIncludeCharts()
setIncludeCharts()
getLoadSheetsOnly()
setLoadSheetsOnly()
setLoadAllSheets()
getReadFilter()
setReadFilter()
getSecurityScanner()
canRead()
load()
setInputEncoding()
getInputEncoding()
loadIntoExisting()
loadFromString()
getSheetIndex()
setSheetIndex()
getStyleColor()
getBorderMappings()
getBorderStyle()
No public properties found
TEST_SAMPLE_SIZE
openFile()
setTableStartColumn()
getTableStartColumn()
releaseTableStartColumn()
flushCell()
processDomElement()
$readDataOnly
$readEmptyCells
$includeCharts
$loadSheetsOnly
$readFilter
$fileHandle
$securityScanner
$inputEncoding
$sheetIndex
$formats
$rowspan
$dataArray
$tableLevel
$nestedColumn
N/A
readBeginning()
readEnding()
startsWithTag()
endsWithTag()
containsTags()
processDomElementBody()
processDomElementTitle()
processDomElementSpanEtc()
processDomElementHr()
processDomElementBr()
processDomElementA()
processDomElementH1Etc()
processDomElementLi()
processDomElementImg()
processDomElementTable()
processDomElementTr()
processDomElementThTdOther()
processDomElementBgcolor()
processDomElementWidth()
processDomElementHeight()
processDomElementAlign()
processDomElementVAlign()
processDomElementDataFormat()
processDomElementThTd()
loadDocument()
applyInlineStyle()
insertImage()
setBorderStyle()
$spanEtc
$h1Etc
$borderMappings
N/A

Constants

TEST_SAMPLE_SIZE

TEST_SAMPLE_SIZE = 2048

Sample size to read to determine if it's HTML or not.

Properties

$readDataOnly

$readDataOnly : bool

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

bool

$readEmptyCells

$readEmptyCells : bool

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.

Type

bool

$includeCharts

$includeCharts : bool

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

bool

$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

$readFilter

$readFilter : \PhpOffice\PhpSpreadsheet\Reader\IReadFilter

IReadFilter instance.

Type

IReadFilter

$fileHandle

$fileHandle

$securityScanner

$securityScanner : \PhpOffice\PhpSpreadsheet\Reader\Security\XmlScanner

Type

XmlScanner

$inputEncoding

$inputEncoding : string

Input encoding.

Type

string

$sheetIndex

$sheetIndex : int

Sheet index to read.

Type

int

$formats

$formats : array

Formats.

Type

array

$rowspan

$rowspan

$dataArray

$dataArray

$tableLevel

$tableLevel

$nestedColumn

$nestedColumn

$spanEtc

$spanEtc

$h1Etc

$h1Etc

$borderMappings

$borderMappings

Methods

__construct()

__construct() : mixed

Create a new HTML Reader instance.

Returns

mixed —

getReadDataOnly()

getReadDataOnly() : bool

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 —

setReadDataOnly()

setReadDataOnly(mixed  $pValue) : \PhpOffice\PhpSpreadsheet\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

mixed $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader —

getReadEmptyCells()

getReadEmptyCells() : bool

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 —

setReadEmptyCells()

setReadEmptyCells(mixed  $pValue) : \PhpOffice\PhpSpreadsheet\Reader\IReader

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

mixed $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader —

getIncludeCharts()

getIncludeCharts() : bool

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 —

setIncludeCharts()

setIncludeCharts(mixed  $pValue) : \PhpOffice\PhpSpreadsheet\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

mixed $pValue

Returns

\PhpOffice\PhpSpreadsheet\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) : \PhpOffice\PhpSpreadsheet\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

\PhpOffice\PhpSpreadsheet\Reader\IReader —

setLoadAllSheets()

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

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

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader —

getReadFilter()

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

Read filter.

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReadFilter —

setReadFilter()

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

Set read filter.

Parameters

\PhpOffice\PhpSpreadsheet\Reader\IReadFilter $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader —

getSecurityScanner()

getSecurityScanner() : mixed

Returns

mixed —

canRead()

canRead(string  $pFilename) : bool

Validate that the current file is an HTML file.

Parameters

string $pFilename

Returns

bool —

load()

load(string  $pFilename) : \PhpOffice\PhpSpreadsheet\Spreadsheet

Loads Spreadsheet from file.

Parameters

string $pFilename

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

setInputEncoding()

setInputEncoding(string  $pValue) : $this

Set input encoding.

Parameters

string $pValue

Input encoding, eg: 'ANSI'

Returns

$this —

getInputEncoding()

getInputEncoding() : string

Get input encoding.

Returns

string —

loadIntoExisting()

loadIntoExisting(string  $pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : \PhpOffice\PhpSpreadsheet\Spreadsheet

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

Parameters

string $pFilename
\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

loadFromString()

loadFromString(string  $content, ?\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet = null) : \PhpOffice\PhpSpreadsheet\Spreadsheet

Spreadsheet from content.

Parameters

string $content
?\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

getSheetIndex()

getSheetIndex() : int

Get sheet index.

Returns

int —

setSheetIndex()

setSheetIndex(int  $pValue) : $this

Set sheet index.

Parameters

int $pValue

Sheet index

Returns

$this —

getStyleColor()

getStyleColor( $value) : null|string

Check if has #, so we can get clean hex.

Parameters

$value

Returns

null|string —

getBorderMappings()

getBorderMappings() : array

Returns

array —

getBorderStyle()

getBorderStyle(string  $style) : null|string

Map html border style to PhpSpreadsheet border style.

Parameters

string $style

Returns

null|string —

openFile()

openFile(string  $pFilename) : void

Open file for reading.

Parameters

string $pFilename

setTableStartColumn()

setTableStartColumn(mixed  $column) : mixed

Parameters

mixed $column

Returns

mixed —

getTableStartColumn()

getTableStartColumn() : mixed

Returns

mixed —

releaseTableStartColumn()

releaseTableStartColumn() : mixed

Returns

mixed —

flushCell()

flushCell(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, mixed  $column, mixed  $row, mixed  $cellContent) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
mixed $column
mixed $row
mixed $cellContent

processDomElement()

processDomElement(\DOMNode  $element, \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent) : void

Parameters

\DOMNode $element
\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent

readBeginning()

readBeginning() : mixed

Returns

mixed —

readEnding()

readEnding() : mixed

Returns

mixed —

startsWithTag()

startsWithTag(mixed  $data) : mixed

Parameters

mixed $data

Returns

mixed —

endsWithTag()

endsWithTag(mixed  $data) : mixed

Parameters

mixed $data

Returns

mixed —

containsTags()

containsTags(mixed  $data) : mixed

Parameters

mixed $data

Returns

mixed —

processDomElementBody()

processDomElementBody(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child

processDomElementTitle()

processDomElementTitle(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementSpanEtc()

processDomElementSpanEtc(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementHr()

processDomElementHr(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementBr()

processDomElementBr(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementA()

processDomElementA(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementH1Etc()

processDomElementH1Etc(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementLi()

processDomElementLi(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementImg()

processDomElementImg(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementTable()

processDomElementTable(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementTr()

processDomElementTr(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementThTdOther()

processDomElementThTdOther(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

processDomElementBgcolor()

processDomElementBgcolor(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
array $attributeArray

processDomElementWidth()

processDomElementWidth(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, string  $column, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
string $column
array $attributeArray

processDomElementHeight()

processDomElementHeight(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
array $attributeArray

processDomElementAlign()

processDomElementAlign(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
array $attributeArray

processDomElementVAlign()

processDomElementVAlign(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
array $attributeArray

processDomElementDataFormat()

processDomElementDataFormat(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
array $attributeArray

processDomElementThTd()

processDomElementThTd(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, string  $cellContent, \DOMElement  $child, array  $attributeArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
string $cellContent
\DOMElement $child
array $attributeArray

loadDocument()

loadDocument(\DOMDocument  $document, \PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : \PhpOffice\PhpSpreadsheet\Spreadsheet

Loads PhpSpreadsheet from DOMDocument into PhpSpreadsheet instance.

Parameters

\DOMDocument $document
\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

applyInlineStyle()

applyInlineStyle(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, int  $row, string  $column, array  $attributeArray) : void

Apply inline css inline style.

NOTES : Currently only intended for td & th element, and only takes 'background-color' and 'color'; property with HEX color

TODO :

  • Implement to other propertie, such as border

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
int $row
string $column
array $attributeArray

insertImage()

insertImage(\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet  $sheet, string  $column, int  $row, array  $attributes) : void

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Worksheet $sheet
string $column
int $row
array $attributes

setBorderStyle()

setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Style  $cellStyle, string  $styleValue, string  $type) : void

Parameters

\PhpOffice\PhpSpreadsheet\Style\Style $cellStyle
string $styleValue
string $type