Documentation

Slk extends BaseReader

in package

• Application

Table of Contents

Constants

COLOR_ARRAY  = [ 'FF00FFFF', // 0 - cyan 'FF000000', // 1 - black 'FFFFFFFF', // 2 - white 'FFFF0000', // 3 - red 'FF00FF00', // 4 - green 'FF0000FF', // 5 - blue 'FFFFFF00', // 6 - yellow 'FFFF00FF', ]

FONT_STYLE_MAPPINGS  = ['B' => 'bold', 'I' => 'italic', 'U' => 'underline']

STYLE_SETTINGS_BORDER  = ['B' => 'bottom', 'L' => 'left', 'R' => 'right', 'T' => 'top']

STYLE_SETTINGS_FONT  = ['D' => 'bold', 'I' => 'italic']

Properties

$fileHandle  : resource

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

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

$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 cells all cells, or should ignore cells containing null value or empty string.

$readFilter  : IReadFilter

IReadFilter instance.

$securityScanner  : XmlScanner|null

$fontcount  : int

Font Count.

$fonts  : array<string|int, mixed>

Fonts.

$format  : int

Format Count.

$formats  : array<string|int, mixed>

Formats.

$sheetIndex  : int

Sheet index to read.

Methods

__construct()  : mixed

Create a new SYLK Reader instance.

canRead()  : bool

Validate that the current file is a SYLK file.

getIncludeCharts()  : bool

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

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

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.

listWorksheetInfo()  : array<string|int, mixed>

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

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

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

load()  : Spreadsheet

Loads Spreadsheet from file.

loadIntoExisting()  : Spreadsheet

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

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.

loadSpreadsheetFromFile()  : Spreadsheet

Loads PhpSpreadsheet from file.

openFile()  : void

Open file for reading.

processFlags()  : void

addFonts()  : void

addFormats()  : void

addStyle()  : void

addWidth()  : void

canReadOrBust()  : void

columnRowFromRowData()  : void

processCFinal()  : void

processCRecord()  : void

processFormula()  : void

processFRecord()  : void

processPColors()  : void

processPFinal()  : void

processPFontStyles()  : void

processPRecord()  : void

styleSettings()  : void