Files
moodle/lib/form/classes/util.php
sam marshall 225eb7b27e MDL-66679 Forms: Submit button remains disabled after file download
When you download a file directly from a Moodle form submit button,
the submit button disables when you click it, but you remain on that
page so we need to re-enable the button.

This commit causes it to re-enable once the file download finishes,
setting a temporary cookie to indicate this to the JavaScript code.

It also adds a method to disable the system on a given form by
setting data-double-submit-protection="off".
2019-10-30 16:36:28 +00:00

65 lines
2.2 KiB
PHP

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Provides the {@link core_form\util} class.
*
* @package core_form
* @copyright 2019 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core_form;
defined('MOODLE_INTERNAL') || die();
/**
* 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
*/
class util {
/**
* 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.
*/
public static function form_download_complete() {
// If this doesn't look like a Moodle QuickForms request, ignore.
$quickform = false;
foreach ($_POST as $name => $value) {
if (preg_match('~^_qf__~', $name)) {
$quickform = true;
break;
}
}
if (!$quickform) {
return;
}
// Set a session cookie.
setcookie('moodledownload_' . sesskey(), time());
}
}