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

$format

$format : int

Format Count.

Type

int

$fonts

$fonts : array

Fonts.

Type

array

$fontcount

$fontcount : int

Font Count.

Type

int

$colorArray

$colorArray

$fontStyleMappings

$fontStyleMappings

$styleSettingsFont

$styleSettingsFont

$styleSettingsBorder

$styleSettingsBorder

Methods

__construct()

__construct() : mixed

Create a new SYLK 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 a SYLK file.

Parameters

string $pFilename

Returns

bool —

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 —

listWorksheetInfo()

listWorksheetInfo(string  $pFilename) : array

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

Parameters

string $pFilename

Returns

array —

load()

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

Loads PhpSpreadsheet from file.

Parameters

string $pFilename

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet —

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 —

getSheetIndex()

getSheetIndex() : int

Get sheet index.

Returns

int —

setSheetIndex()

setSheetIndex(int  $pValue) : $this

Set sheet index.

Parameters

int $pValue

Sheet index

Returns

$this —

openFile()

openFile(string  $pFilename) : void

Open file for reading.

Parameters

string $pFilename

canReadOrBust()

canReadOrBust(string  $pFilename) : void

Parameters

string $pFilename

processFormula()

processFormula(string  $rowDatum, bool  $hasCalculatedValue, string  $cellDataFormula, string  $row, string  $column) : void

Parameters

string $rowDatum
bool $hasCalculatedValue
string $cellDataFormula
string $row
string $column

processCRecord()

processCRecord(array  $rowData, \PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, string  $row, string  $column) : void

Parameters

array $rowData
\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
string $row
string $column

processCFinal()

processCFinal(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, bool  $hasCalculatedValue, string  $cellDataFormula, string  $cellData, string  $coordinate) : void

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
bool $hasCalculatedValue
string $cellDataFormula
string $cellData
string $coordinate

processFRecord()

processFRecord(array  $rowData, \PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, string  $row, string  $column) : void

Parameters

array $rowData
\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
string $row
string $column

styleSettings()

styleSettings(string  $rowDatum, array  $styleData, string  $fontStyle) : void

Parameters

string $rowDatum
array $styleData
string $fontStyle

addFormats()

addFormats(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, string  $formatStyle, string  $row, string  $column) : void

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
string $formatStyle
string $row
string $column

addFonts()

addFonts(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, string  $fontStyle, string  $row, string  $column) : void

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
string $fontStyle
string $row
string $column

addStyle()

addStyle(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, array  $styleData, string  $row, string  $column) : void

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
array $styleData
string $row
string $column

addWidth()

addWidth(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, string  $columnWidth, string  $startCol, string  $endCol) : void

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
string $columnWidth
string $startCol
string $endCol

processPRecord()

processPRecord(array  $rowData, \PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : void

Parameters

array $rowData
\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

processPColors()

processPColors(string  $rowDatum, array  $formatArray) : void

Parameters

string $rowDatum
array $formatArray

processPFontStyles()

processPFontStyles(string  $rowDatum, array  $formatArray) : void

Parameters

string $rowDatum
array $formatArray

processPFinal()

processPFinal(\PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet, array  $formatArray) : void

Parameters

\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
array $formatArray

columnRowFromRowData()

columnRowFromRowData(array  $rowData, string  $column, string  $row) : void

Parameters

array $rowData
string $column
string $row