Merge branch 'MDL-71796-master' of git://github.com/lameze/moodle
[moodle.git] / dataformat / upgrade.txt
CommitLineData
bff1edbe
BH
1This files describes API changes in /dataformat/ download system,
2information provided here is intended especially for developers.
3
1de3b819
PH
4=== 3.9 ===
5* The following methods have been added to the base dataformat class to allow instances to export to a local
6 file. They can be overridden in extending classes to define how files should be created:
7 - start_output_to_file()
8 - close_output_to_file()
8844cb82
PH
9* Calls to the following dataformat plugin methods have been removed:
10 - write_header()
11 - write_footer()
233a51ad
PH
12* The following methods have been added to the base class to allow instances to define support for exporting
13 HTML content, with additional support for defining how images should be embedded:
14 - supports_html()
15 - export_html_image_source()
16* Dataformat writers should also call the following method to ensure data is properly formatted before being
17 written, which takes into account prior methods defining support for HTML:
18 - format_record()
bff1edbe 19
1de3b819 20=== 3.4 ===
d4606c1b 21* In order to allow multiple sheets in an exported file the functions write_header() and write_footer() have
e0ee37e4
MN
22 been removed from core dataformat plugins and have been replaced.
23 - write_header() has been replaced with the two functions start_output() and start_sheet().
24 - write_footer() has been replaced with the two functions close_output() and close_sheet().
d4606c1b
MN
25 For backwards compatibility write_header() and write_footer() will continue to work but if used will
26 trigger the function error_log().
bff1edbe 27
d4606c1b
MN
28=== 3.1 ===
29* Added new plugin system with low memory support for csv, ods, xls and json