[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Provides the {@link core_form\util} class.
  19   *
  20   * @package core_form
  21   * @copyright 2019 The Open University
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_form;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * General utility class for form-related methods.
  31   *
  32   * @copyright 2019 The Open University
  33   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class util {
  36      /**
  37       * This function should be called if a form submit results in a file download (i.e. with the
  38       * Content-Disposition: attachment header) instead of navigating to a new page, before the
  39       * file download is sent. It will set a cookie which is used to inform page javascript in
  40       * submit.js.
  41       *
  42       * You may call this function in scripts which might not necessarily be called from forms; it
  43       * will only set the cookie if there is a POST request from a form.
  44       *
  45       * This is automatically called from various points in Moodle such as send_file_xx functions
  46       * in filelib.php.
  47       */
  48      public static function form_download_complete() {
  49          // If this doesn't look like a Moodle QuickForms request, ignore.
  50          $quickform = false;
  51          foreach ($_POST as $name => $value) {
  52              if (preg_match('~^_qf__~', $name)) {
  53                  $quickform = true;
  54                  break;
  55              }
  56          }
  57          if (!$quickform) {
  58              return;
  59          }
  60  
  61          // Set a session cookie.
  62          setcookie('moodledownload_' . sesskey(), time());
  63      }
  64  }