[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Reader/CSV/ -> Reader.php (summary)

(no description)

File Size: 152 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Reader:: (8 methods):
  setFieldDelimiter()
  setFieldEnclosure()
  setEncoding()
  setEndOfLineCharacter()
  doesSupportStreamWrapper()
  openReader()
  getConcreteSheetIterator()
  closeReader()


Class: Reader  - X-Ref

Class Reader
This class provides support to read data from a CSV file.

setFieldDelimiter($fieldDelimiter)   X-Ref
Sets the field delimiter for the CSV.
Needs to be called before opening the reader.

param: string $fieldDelimiter Character that delimits fields
return: Reader

setFieldEnclosure($fieldEnclosure)   X-Ref
Sets the field enclosure for the CSV.
Needs to be called before opening the reader.

param: string $fieldEnclosure Character that enclose fields
return: Reader

setEncoding($encoding)   X-Ref
Sets the encoding of the CSV file to be read.
Needs to be called before opening the reader.

param: string $encoding Encoding of the CSV file to be read
return: Reader

setEndOfLineCharacter($endOfLineCharacter)   X-Ref
Sets the EOL for the CSV.
Needs to be called before opening the reader.

param: string $endOfLineCharacter used to properly get lines from the CSV file.
return: Reader

doesSupportStreamWrapper()   X-Ref
Returns whether stream wrappers are supported

return: bool

openReader($filePath)   X-Ref
Opens the file at the given path to make it ready to be read.
If setEncoding() was not called, it assumes that the file is encoded in UTF-8.

param: string $filePath Path of the CSV file to be read
return: void

getConcreteSheetIterator()   X-Ref
Returns an iterator to iterate over sheets.

return: SheetIterator To iterate over sheets

closeReader()   X-Ref
Closes the reader. To be used after reading the file.

return: void



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1