Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/spout/src/Spout/Reader/CSV/ -> Reader.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 39 and 400] [Versions 400 and 401]

(no description)

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

Defines 1 class

Reader:: (7 methods):
  setFieldDelimiter()
  setFieldEnclosure()
  setEncoding()
  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.

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

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

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

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

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

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.

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

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