Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 402] [Versions 310 and 403]

Common Spout class for dataformat.

Copyright: 2016 Brendan Heywood (brendan@catalyst-au.net)
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 145 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

spout_base:: (7 methods):
  send_http_headers()
  start_output_to_file()
  set_sheettitle()
  start_sheet()
  write_record()
  close_output()
  close_output_to_file()


Class: spout_base  - X-Ref

Common Spout class for dataformat.

send_http_headers()   X-Ref
Output file headers to initialise the download of the file.


start_output_to_file()   X-Ref
Set the dataformat to be output to current file


set_sheettitle($title)   X-Ref
Set the title of the worksheet inside a spreadsheet

For some formats this will be ignored.

param: string $title

start_sheet($columns)   X-Ref
Write the start of the sheet we will be adding data to.

param: array $columns

write_record($record, $rownum)   X-Ref
Write a single record

param: array $record
param: int $rownum

close_output()   X-Ref
Write the end of the file.


close_output_to_file()   X-Ref
Write data to disk

return: bool