Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/spout/src/Spout/Writer/CSV/ -> Writer.php (source)

[Source view]

(no description)

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

Defines 1 class

Writer:: (6 methods):
  setFieldDelimiter()
  setFieldEnclosure()
  setShouldAddBOM()
  openWriter()
  addRowToWriter()
  closeWriter()


Class: Writer  - X-Ref

Class Writer
This class provides support to write data to CSV files

setFieldDelimiter($fieldDelimiter)   X-Ref
Sets the field delimiter for the CSV

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

setFieldEnclosure($fieldEnclosure)   X-Ref
Sets the field enclosure for the CSV

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

setShouldAddBOM($shouldAddBOM)   X-Ref
Set if a BOM has to be added to the file

param: bool $shouldAddBOM
return: Writer

openWriter()   X-Ref
Opens the CSV streamer and makes it ready to accept data.

return: void

addRowToWriter(Row $row)   X-Ref
Adds a row to the currently opened writer.

param: Row $row The row containing cells and styles
return: void

closeWriter()   X-Ref
Closes the CSV streamer, preventing any additional writing.
If set, sets the headers and redirects output to the browser.

return: void