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

$readEmptyCells

$readEmptyCells : boolean

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

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

$delimiter

$delimiter : string

Delimiter.

Type

string

$enclosure

$enclosure : string

Enclosure.

Type

string

$sheetIndex

$sheetIndex : integer

Sheet index to read.

Type

integer

$contiguous

$contiguous : boolean

Load rows contiguously.

Type

boolean

$contiguousRow

$contiguousRow : integer

Row counter for loading rows contiguously.

Type

integer

$escapeCharacter

$escapeCharacter : string

The character that can escape the enclosure.

Type

string

Methods

__construct()

__construct() 

Create a new CSV Reader instance.

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

boolean $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader

getReadEmptyCells()

getReadEmptyCells() : boolean

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

boolean

setReadEmptyCells()

setReadEmptyCells(boolean  $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

boolean $pValue

Returns

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

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

getSecurityScanner()

getSecurityScanner() 

setInputEncoding()

setInputEncoding(string  $pValue) : $this

Set input encoding.

Parameters

string $pValue

Input encoding, eg: 'UTF-8'

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

Throws

\PhpOffice\PhpSpreadsheet\Reader\Exception

Returns

array

load()

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

Loads Spreadsheet from file.

Parameters

string $pFilename

Throws

\PhpOffice\PhpSpreadsheet\Reader\Exception

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

Throws

\PhpOffice\PhpSpreadsheet\Reader\Exception

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet

getDelimiter()

getDelimiter() : string

Get delimiter.

Returns

string

setDelimiter()

setDelimiter(string  $delimiter) : $this

Set delimiter.

Parameters

string $delimiter

Delimiter, eg: ','

Returns

$this

getEnclosure()

getEnclosure() : string

Get enclosure.

Returns

string

setEnclosure()

setEnclosure(string  $enclosure) : $this

Set enclosure.

Parameters

string $enclosure

Enclosure, defaults to "

Returns

$this

getSheetIndex()

getSheetIndex() : integer

Get sheet index.

Returns

integer

setSheetIndex()

setSheetIndex(integer  $pValue) : $this

Set sheet index.

Parameters

integer $pValue

Sheet index

Returns

$this

setContiguous()

setContiguous(boolean  $contiguous) : $this

Set Contiguous.

Parameters

boolean $contiguous

Returns

$this

getContiguous()

getContiguous() : boolean

Get Contiguous.

Returns

boolean

setEscapeCharacter()

setEscapeCharacter(string  $escapeCharacter) : $this

Set escape backslashes.

Parameters

string $escapeCharacter

Returns

$this

getEscapeCharacter()

getEscapeCharacter() : string

Get escape backslashes.

Returns

string

canRead()

canRead(string  $pFilename) : boolean

Can the current IReader read the file?

Parameters

string $pFilename

Returns

boolean

openFile()

openFile(string  $pFilename) 

Open file for reading.

Parameters

string $pFilename

Throws

\PhpOffice\PhpSpreadsheet\Reader\Exception

skipBOM()

skipBOM() 

Move filepointer past any BOM marker.

checkSeparator()

checkSeparator() 

Identify any separator that is explicitly set in the file.

inferSeparator()

inferSeparator() 

Infer the separator if it isn't explicitly set in the file or specified by the user.

getNextLine()

getNextLine(string  $line = '') : boolean|string

Get the next full line from the file.

Parameters

string $line

Returns

boolean|string