Documentation

Html extends BaseReader

in package

• Application

Table of Contents

Constants

TEST_SAMPLE_SIZE  = 2048

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

FORMATS  = [ 'h1' => ['font' => ['bold' => true, 'size' => 24]], // Bold, 24pt 'h2' => ['font' => ['bold' => true, 'size' => 18]], // Bold, 18pt 'h3' => ['font' => ['bold' => true, 'size' => 13.5]], // Bold, 13.5pt 'h4' => ['font' => ['bold' => true, 'size' => 12]], // Bold, 12pt 'h5' => ['font' => ['bold' => true, 'size' => 10]], // Bold, 10pt 'h6' => ['font' => ['bold' => true, 'size' => 7.5]], // Bold, 7.5pt 'a' => ['font' => ['underline' => true, 'color' => ['argb' => \PhpOffice\PhpSpreadsheet\Style\Color::COLOR_BLUE]]], // Blue underlined 'hr' => ['borders' => ['bottom' => ['borderStyle' => \PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THIN, 'color' => [\PhpOffice\PhpSpreadsheet\Style\Color::COLOR_BLACK]]]], // Bottom border 'strong' => ['font' => ['bold' => true]], // Bold 'b' => ['font' => ['bold' => true]], // Bold 'i' => ['font' => ['italic' => true]], // Italic 'em' => ['font' => ['italic' => true]], ]

Formats.

Properties

$allowExternalImages  : bool

Allow external images. Use with caution.

$createBlankSheetIfNoneRead  : bool

Create a blank sheet if none are read, possibly due to a typo when using LoadSheetsOnly.

$dataArray  : array<string|int, array<string|int, mixed>>

Data Array used for testing only, should write to Spreadsheet object on completion of tests.

$fileHandle  : resource

$ignoreRowsWithNoCells  : bool

Ignore rows with no cells? Identifies whether the Reader should ignore rows with no cells.

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

$inputEncoding  : string

Input encoding.

$loadSheetsOnly  : null|array<string|int, string>

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.

$nestedColumn  : array<string|int, string>

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

$readEmptyCells  : bool

Read empty cells? Identifies whether the Reader should read data values for all cells, or should ignore cells containing null value or empty string.

$readFilter  : IReadFilter

IReadFilter instance.

$rowspan  : array<string, bool>

$securityScanner  : XmlScanner|null

$sheetIndex  : int

Sheet index to read.

$tableLevel  : int

$valueBinder  : IValueBinder|null

Methods

__construct()  : mixed

Create a new HTML Reader instance.

canRead()  : bool

Validate that the current file is an HTML file.

getAllowExternalImages()  : bool

getBorderMappings()  : array<string, string>

getBorderStyle()  : string|null

Map html border style to PhpSpreadsheet border style.

getIgnoreRowsWithNoCells()  : bool

getIncludeCharts()  : bool

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

getLoadSheetsOnly()  : null|array<string|int, string>

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.

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 or structural information (like merges).

getReadEmptyCells()  : bool

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

getReadFilter()  : IReadFilter

Read filter.

getSecurityScanner()  : XmlScanner|null

getSecurityScannerOrThrow()  : XmlScanner

getSheetIndex()  : int

Get sheet index.

getStyleColor()  : string

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

getValueBinder()  : IValueBinder|null

listWorksheetInfo()  : array<int, array{worksheetName: string, lastColumnLetter: string, lastColumnIndex: int, totalRows: int, totalColumns: int, sheetState: string}>

Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).

listWorksheetNames()  : array<string|int, string>

Returns names of the worksheets from a file, possibly without parsing the whole file to a Spreadsheet object.

load()  : Spreadsheet

Loads Spreadsheet from file.

loadFromString()  : Spreadsheet

Spreadsheet from content.

loadIntoExisting()  : Spreadsheet

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

loadSpreadsheetFromFile()  : Spreadsheet

Loads Spreadsheet from file.

setAllowExternalImages()  : self

Allow external images. Use with caution.

setCreateBlankSheetIfNoneRead()  : self

Create a blank sheet if none are read, possibly due to a typo when using LoadSheetsOnly.

setIgnoreRowsWithNoCells()  : self

setIncludeCharts()  : $this

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

setLoadAllSheets()  : $this

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

setLoadSheetsOnly()  : $this

Set which sheets to load.

setReadDataOnly()  : $this

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting or structural information (like merges).

setReadEmptyCells()  : $this

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

setReadFilter()  : $this

Set read filter.

setSheetIndex()  : $this

Set sheet index.

setValueBinder()  : self

flushCell()  : void

Flush cell.

getTableStartColumn()  : string

newSpreadsheet()  : Spreadsheet

openFile()  : void

Open file for reading.

processDomElement()  : void

processFlags()  : void

releaseTableStartColumn()  : string

replaceNonAsciiIfNeeded()  : string|null

setTableStartColumn()  : string