\PHPExcel_Reader_CSV

PHPExcel_Reader_CSV

Copyright (c) 2006 - 2015 PHPExcel

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Summary

Methods
Properties
Constants
getReadDataOnly()
setReadDataOnly()
getReadEmptyCells()
setReadEmptyCells()
getIncludeCharts()
setIncludeCharts()
getLoadSheetsOnly()
setLoadSheetsOnly()
setLoadAllSheets()
getReadFilter()
setReadFilter()
canRead()
securityScan()
securityScanFile()
__construct()
setInputEncoding()
getInputEncoding()
listWorksheetInfo()
load()
loadIntoExisting()
getDelimiter()
setDelimiter()
getEnclosure()
setEnclosure()
getSheetIndex()
setSheetIndex()
setContiguous()
getContiguous()
No public properties found
No constants found
openFile()
isValidFormat()
skipBOM()
checkSeparator()
$readDataOnly
$readEmptyCells
$includeCharts
$loadSheetsOnly
$readFilter
$fileHandle
N/A
No private methods found
$inputEncoding
$delimiter
$enclosure
$sheetIndex
$contiguous
$contiguousRow
N/A

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 : integer

Load rows contiguously

Type

integer

$contiguousRow

$contiguousRow : integer

Row counter for loading rows contiguously

Type

integer

Methods

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 = false) : \PHPExcel_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

\PHPExcel_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 = true) : \PHPExcel_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

\PHPExcel_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 = false) : \PHPExcel_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

\PHPExcel_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 = null) : \PHPExcel_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

\PHPExcel_Reader_IReader

setLoadAllSheets()

setLoadAllSheets() : \PHPExcel_Reader_IReader

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

Returns

\PHPExcel_Reader_IReader

canRead()

canRead(string  $pFilename) : boolean

Can the current PHPExcel_Reader_IReader read the file?

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

boolean

securityScan()

securityScan(string  $xml) 

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Parameters

string $xml

Throws

\PHPExcel_Reader_Exception

securityScanFile()

securityScanFile(string  $filestream) 

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks

Parameters

string $filestream

Throws

\PHPExcel_Reader_Exception

__construct()

__construct() 

Create a new PHPExcel_Reader_CSV

setInputEncoding()

setInputEncoding(string  $pValue = 'UTF-8') 

Set input encoding

Parameters

string $pValue

Input encoding

getInputEncoding()

getInputEncoding() : string

Get input encoding

Returns

string

listWorksheetInfo()

listWorksheetInfo(string  $pFilename) 

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

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

load()

load(string  $pFilename) : \PHPExcel

Loads PHPExcel from file

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

\PHPExcel

loadIntoExisting()

loadIntoExisting(string  $pFilename, \PHPExcel  $objPHPExcel) : \PHPExcel

Loads PHPExcel from file into PHPExcel instance

Parameters

string $pFilename
\PHPExcel $objPHPExcel

Throws

\PHPExcel_Reader_Exception

Returns

\PHPExcel

getDelimiter()

getDelimiter() : string

Get delimiter

Returns

string

setDelimiter()

setDelimiter(string  $pValue = ',') : \PHPExcel_Reader_CSV

Set delimiter

Parameters

string $pValue

Delimiter, defaults to ,

Returns

\PHPExcel_Reader_CSV

getEnclosure()

getEnclosure() : string

Get enclosure

Returns

string

setEnclosure()

setEnclosure(string  $pValue = '"') : \PHPExcel_Reader_CSV

Set enclosure

Parameters

string $pValue

Enclosure, defaults to "

Returns

\PHPExcel_Reader_CSV

getSheetIndex()

getSheetIndex() : integer

Get sheet index

Returns

integer

setSheetIndex()

setSheetIndex(integer  $pValue) : \PHPExcel_Reader_CSV

Set sheet index

Parameters

integer $pValue

Sheet index

Returns

\PHPExcel_Reader_CSV

setContiguous()

setContiguous(boolean  $contiguous = false) 

Set Contiguous

Parameters

boolean $contiguous

getContiguous()

getContiguous() : boolean

Get Contiguous

Returns

boolean

openFile()

openFile(string  $pFilename) : resource

Open file for reading

Parameters

string $pFilename

Throws

\PHPExcel_Reader_Exception

Returns

resource

isValidFormat()

isValidFormat() : boolean

Validate that the current file is a CSV file

Returns

boolean

skipBOM()

skipBOM() 

Move filepointer past any BOM marker

checkSeparator()

checkSeparator() 

Identify any separator that is explicitly set in the file