class Csv extends BaseReader (View source)

Properties

protected bool $readDataOnly 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. from BaseReader
protected bool $readEmptyCells 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. from BaseReader
protected bool $includeCharts Read charts that are defined in the workbook? Identifies whether the Reader should read the definitions for any charts that exist in the workbook;. from BaseReader
protected array $loadSheetsOnly 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. from BaseReader
protected IReadFilter $readFilter IReadFilter instance. from BaseReader
protected $fileHandle from BaseReader
protected XmlScanner $securityScanner from BaseReader

Methods

__construct()

IReader constructor.

bool
getReadDataOnly()

Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information.

setReadDataOnly(bool $pValue)

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.

bool
getReadEmptyCells()

Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value.

setReadEmptyCells(bool $pValue)

Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.

bool
getIncludeCharts()

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

setIncludeCharts(bool $pValue)

Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook.

mixed
getLoadSheetsOnly()

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.

setLoadSheetsOnly(mixed $value)

Set which sheets to load.

setLoadAllSheets()

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

getReadFilter()

Read filter.

setReadFilter(IReadFilter $pValue)

Set read filter.

getSecurityScanner()

No description

openFile(string $pFilename)

Open file for reading.

Csv
setInputEncoding(string $pValue)

Set input encoding.

string
getInputEncoding()

Get input encoding.

skipBOM()

Move filepointer past any BOM marker.

checkSeparator()

Identify any separator that is explicitly set in the file.

inferSeparator()

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

array
listWorksheetInfo(string $pFilename)

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

load(string $pFilename)

Loads PhpSpreadsheet from file.

loadIntoExisting(string $pFilename, Spreadsheet $spreadsheet)

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

string
getDelimiter()

Get delimiter.

CSV
setDelimiter(string $delimiter)

Set delimiter.

string
getEnclosure()

Get enclosure.

CSV
setEnclosure(string $enclosure)

Set enclosure.

int
getSheetIndex()

Get sheet index.

CSV
setSheetIndex(int $pValue)

Set sheet index.

Csv
setContiguous(bool $contiguous)

Set Contiguous.

bool
getContiguous()

Get Contiguous.

$this
setEscapeCharacter(string $escapeCharacter)

Set escape backslashes.

string
getEscapeCharacter()

Get escape backslashes.

bool
canRead(string $pFilename)

Can the current IReader read the file?

Details

__construct()

IReader constructor.

bool getReadDataOnly()

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.

Return Value

bool

IReader setReadDataOnly(bool $pValue)

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

bool $pValue

Return Value

IReader

bool getReadEmptyCells()

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.

Return Value

bool

IReader setReadEmptyCells(bool $pValue)

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

bool $pValue

Return Value

IReader

bool getIncludeCharts()

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.

Return Value

bool

IReader setIncludeCharts(bool $pValue)

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

bool $pValue

Return Value

IReader

mixed getLoadSheetsOnly()

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.

Return Value

mixed

IReader setLoadSheetsOnly(mixed $value)

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

Return Value

IReader

IReader setLoadAllSheets()

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

Return Value

IReader

IReadFilter getReadFilter()

Read filter.

Return Value

IReadFilter

IReader setReadFilter(IReadFilter $pValue)

Set read filter.

Parameters

IReadFilter $pValue

Return Value

IReader

getSecurityScanner()

protected openFile(string $pFilename)

Open file for reading.

Parameters

string $pFilename

Exceptions

Exception

Csv setInputEncoding(string $pValue)

Set input encoding.

Parameters

string $pValue Input encoding, eg: 'UTF-8'

Return Value

Csv

string getInputEncoding()

Get input encoding.

Return Value

string

protected skipBOM()

Move filepointer past any BOM marker.

protected checkSeparator()

Identify any separator that is explicitly set in the file.

protected inferSeparator()

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

array listWorksheetInfo(string $pFilename)

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

Parameters

string $pFilename

Return Value

array

Exceptions

Exception

Spreadsheet load(string $pFilename)

Loads PhpSpreadsheet from file.

Parameters

string $pFilename

Return Value

Spreadsheet

Exceptions

Exception

Spreadsheet loadIntoExisting(string $pFilename, Spreadsheet $spreadsheet)

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

Parameters

string $pFilename
Spreadsheet $spreadsheet

Return Value

Spreadsheet

Exceptions

Exception

string getDelimiter()

Get delimiter.

Return Value

string

CSV setDelimiter(string $delimiter)

Set delimiter.

Parameters

string $delimiter Delimiter, eg: ','

Return Value

CSV

string getEnclosure()

Get enclosure.

Return Value

string

CSV setEnclosure(string $enclosure)

Set enclosure.

Parameters

string $enclosure Enclosure, defaults to "

Return Value

CSV

int getSheetIndex()

Get sheet index.

Return Value

int

CSV setSheetIndex(int $pValue)

Set sheet index.

Parameters

int $pValue Sheet index

Return Value

CSV

Csv setContiguous(bool $contiguous)

Set Contiguous.

Parameters

bool $contiguous

Return Value

Csv

bool getContiguous()

Get Contiguous.

Return Value

bool

$this setEscapeCharacter(string $escapeCharacter)

Set escape backslashes.

Parameters

string $escapeCharacter

Return Value

$this

string getEscapeCharacter()

Get escape backslashes.

Return Value

string

bool canRead(string $pFilename)

Can the current IReader read the file?

Parameters

string $pFilename

Return Value

bool