Constants

UTF8_BOM

UTF8_BOM = ""

UTF8_BOM_LEN

UTF8_BOM_LEN = 3

UTF16BE_BOM

UTF16BE_BOM = "\xfe\xff"

UTF16BE_BOM_LEN

UTF16BE_BOM_LEN = 2

UTF16BE_LF

UTF16BE_LF = "\x00\n"

UTF16LE_BOM

UTF16LE_BOM = "\xff\xfe"

UTF16LE_BOM_LEN

UTF16LE_BOM_LEN = 2

UTF16LE_LF

UTF16LE_LF = "\n\x00"

UTF32BE_BOM

UTF32BE_BOM = "\x00\x00\xfe\xff"

UTF32BE_BOM_LEN

UTF32BE_BOM_LEN = 4

UTF32BE_LF

UTF32BE_LF = "\x00\x00\x00\n"

UTF32LE_BOM

UTF32LE_BOM = "\xff\xfe\x00\x00"

UTF32LE_BOM_LEN

UTF32LE_BOM_LEN = 4

UTF32LE_LF

UTF32LE_LF = "\n\x00\x00\x00"

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

$delimiter

$delimiter : string

Delimiter.

Type

string

$enclosure

$enclosure : string

Enclosure.

Type

string

$sheetIndex

$sheetIndex : int

Sheet index to read.

Type

int

$contiguous

$contiguous : bool

Load rows contiguously.

Type

bool

$escapeCharacter

$escapeCharacter : string

The character that can escape the enclosure.

Type

string

Methods

__construct()

__construct() : mixed

Create a new CSV 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 —

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

Returns

array —

load()

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

Loads Spreadsheet 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 —

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() : int

Get sheet index.

Returns

int —

setSheetIndex()

setSheetIndex(int  $pValue) : $this

Set sheet index.

Parameters

int $pValue

Sheet index

Returns

$this —

setContiguous()

setContiguous(bool  $contiguous) : $this

Set Contiguous.

Parameters

bool $contiguous

Returns

$this —

getContiguous()

getContiguous() : bool

Get Contiguous.

Returns

bool —

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

Can the current IReader read the file?

Parameters

string $pFilename

Returns

bool —

guessEncoding()

guessEncoding(string  $filename, string  $dflt = 'CP1252') : string

Parameters

string $filename
string $dflt

Returns

string —

openFile()

openFile(string  $pFilename) : void

Open file for reading.

Parameters

string $pFilename

skipBOM()

skipBOM() : void

Move filepointer past any BOM marker.

checkSeparator()

checkSeparator() : void

Identify any separator that is explicitly set in the file.

inferSeparator()

inferSeparator() : void

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

getNextLine()

getNextLine() : false|string

Get the next full line from the file.

Returns

false|string —

openFileOrMemory()

openFileOrMemory(mixed  $pFilename) : void

Parameters

mixed $pFilename

guessEncodingTestNoBom()

guessEncodingTestNoBom(string  $encoding, string  $contents, string  $compare, string  $setEncoding) : void

Parameters

string $encoding
string $contents
string $compare
string $setEncoding

guessEncodingNoBom()

guessEncodingNoBom(string  $filename) : string

Parameters

string $filename

Returns

string —

guessEncodingTestBom()

guessEncodingTestBom(string  $encoding, string  $first4, string  $compare, string  $setEncoding) : void

Parameters

string $encoding
string $first4
string $compare
string $setEncoding

guessEncodingBom()

guessEncodingBom(string  $filename) : string

Parameters

string $filename

Returns

string —