Documentation

Csv extends BaseReader

in package

• Application

Table of Contents

Constants

DEFAULT_FALLBACK_ENCODING  = 'CP1252'

DEFAULT_TEST_AUTODETECT  = false

Changed from true to false in release 4.0.0

GUESS_ENCODING  = 'guess'

UTF16BE_BOM  = "\xfe\xff"

UTF16BE_BOM_LEN  = 2

UTF16BE_LF  = "\x00\n"

UTF16LE_BOM  = "\xff\xfe"

UTF16LE_BOM_LEN  = 2

UTF16LE_LF  = "\n\x00"

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

UTF32BE_BOM_LEN  = 4

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

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

UTF32LE_BOM_LEN  = 4

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

UTF8_BOM  = ""

UTF8_BOM_LEN  = 3

Properties

$castFormattedNumberToNumeric  : bool

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

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

$preserveNumericFormatting  : bool

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

$securityScanner  : XmlScanner|null

$valueBinder  : IValueBinder|null

$constructorCallback  : callable|null

Callback for setting defaults in construction.

$contiguous  : bool

Load rows contiguously.

$decimalSeparator  : string

$delimiter  : string|null

Delimiter.

$enclosure  : string

Enclosure.

$escapeCharacter  : string|null

The character that can escape the enclosure.

$fallbackEncoding  : string

Fallback encoding if guess strikes out.

$getFalse  : string

$getTrue  : string

$inputEncoding  : string

Input encoding.

$preserveNullString  : bool

$sheetIndex  : int

Sheet index to read.

$sheetNameIsFileName  : bool

$testAutodetect  : bool

Attempt autodetect line endings (deprecated after PHP8.1)?

$thousandsSeparator  : string

Methods

__construct()  : mixed

Create a new CSV Reader instance.

affectedByPhp9()  : bool

canRead()  : bool

Can the current IReader read the file?

castFormattedNumberToNumeric()  : void

getConstructorCallback()  : callable|null

getContiguous()  : bool

getDelimiter()  : string|null

getEnclosure()  : string

getEscapeCharacter()  : string

getFallbackEncoding()  : string

getIgnoreRowsWithNoCells()  : bool

getIncludeCharts()  : bool

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

getInputEncoding()  : string

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.

getPreserveNullString()  : bool

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

getValueBinder()  : IValueBinder|null

guessEncoding()  : string

guessEncodingBom()  : string

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.

loadIntoExisting()  : Spreadsheet

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

loadSpreadsheetFromString()  : Spreadsheet

Loads Spreadsheet from string.

setConstructorCallback()  : void

Set a callback to change the defaults.

setContiguous()  : self

setDelimiter()  : self

setEnclosure()  : self

setEscapeCharacter()  : self

Php9 intends to drop support for this parameter in fgetcsv.

setFallbackEncoding()  : self

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.

setInputEncoding()  : self

setLoadAllSheets()  : $this

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

setLoadSheetsOnly()  : $this

Set which sheets to load.

setPreserveNullString()  : self

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

setSheetNameIsFileName()  : self

setTestAutoDetect()  : self

setValueBinder()  : self

checkSeparator()  : void

Identify any separator that is explicitly set in the file.

inferSeparator()  : void

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

loadSpreadsheetFromFile()  : Spreadsheet

Loads Spreadsheet from file.

newSpreadsheet()  : Spreadsheet

openFile()  : void

Open file for reading.

processFlags()  : void

skipBOM()  : void

Move filepointer past any BOM marker.

convertBoolean()  : void

Convert string true/false to boolean, and null to null-string.

convertFormattedNumber()  : string

Convert numeric strings to int or float values.

getCsv()  : array<int, string|null>|false

Php8.4 deprecates use of anything other than null string as escape Character.

getDefaultEscapeCharacter()  : string

The character that will be supplied to fgetcsv when escapeCharacter is null.

guessEncodingNoBom()  : string

guessEncodingTestBom()  : void

guessEncodingTestNoBom()  : void

loadStringOrFile()  : Spreadsheet

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

loadStringOrFile2()  : void

openDataUri()  : void

Open data uri for reading.

openFileOrMemory()  : void

setAutoDetect()  : string|null