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.
/lib/form/classes/ -> util.php (source)

[Source view]

Provides the {@link core_form\util} class.

Copyright: 2019 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 64 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

util:: (1 method):
  form_download_complete()


Class: util  - X-Ref

General utility class for form-related methods.

form_download_complete()   X-Ref
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.