core_form\util Class Reference

General utility class for form-related methods. More...

Static Public Member Functions
static	form_download_complete ()
	This function should be called if a form submit results in a file download (i.e.

Detailed Description

General utility class for form-related methods.

Copyright

2019 The Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

form_download_complete()

static core_form\util::form_download_complete ( )

static

This function should be called if a form submit results in a file download (i.e.

with the Content-Disposition: attachment header) instead of navigating to a new page, before the file download is sent. It will set a cookie which is used to inform page javascript in submit.js.

You may call this function in scripts which might not necessarily be called from forms; it will only set the cookie if there is a POST request from a form.

This is automatically called from various points in Moodle such as send_file_xx functions in filelib.php.

---

The documentation for this class was generated from the following file:

• lib/form/classes/util.php