MDL-71981 dataformat: indicate HTML support in writer callback.
[moodle.git] / dataformat / upgrade.txt
1 This files describes API changes in /dataformat/ download system,
2 information provided here is intended especially for developers.
4 === 3.11.1 ===
5 * Optional $callback for the following \core\dataformat methods now receive a second argument to define
6   whether the current format writer supports HTML:
7   - download_data()
8   - write_data()
9   - write_data_to_filearea()
11 === 3.9 ===
12 * The following methods have been added to the base dataformat class to allow instances to export to a local
13   file. They can be overridden in extending classes to define how files should be created:
14   - start_output_to_file()
15   - close_output_to_file()
16 * Calls to the following dataformat plugin methods have been removed:
17   - write_header()
18   - write_footer()
19 * The following methods have been added to the base class to allow instances to define support for exporting
20   HTML content, with additional support for defining how images should be embedded:
21   - supports_html()
22   - export_html_image_source()
23 * Dataformat writers should also call the following method to ensure data is properly formatted before being
24   written, which takes into account prior methods defining support for HTML:
25   - format_record()
27 === 3.4 ===
28 * In order to allow multiple sheets in an exported file the functions write_header() and write_footer() have
29   been removed from core dataformat plugins and have been replaced.
30   - write_header() has been replaced with the two functions start_output() and start_sheet().
31   - write_footer() has been replaced with the two functions close_output() and close_sheet().
32   For backwards compatibility write_header() and write_footer() will continue to work but if used will
33   trigger the function error_log().
35 === 3.1 ===
36 * Added new plugin system with low memory support for csv, ods, xls and json