[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   * Generate the links to open/download the Safe Exam Browser with correct settings.
  19   *
  20   * @package    quizaccess_seb
  21   * @author     Andrew Madden <andrewmadden@catalyst-au.net>
  22   * @copyright  2019 Catalyst IT
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace quizaccess_seb;
  27  
  28  use moodle_url;
  29  
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  /**
  33   * Generate the links to open/download the Safe Exam Browser with correct settings.
  34   *
  35   * @copyright  2020 Catalyst IT
  36   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class link_generator {
  39  
  40      /**
  41       * Get a link to force the download of the file over https or sebs protocols.
  42       *
  43       * @param string $cmid Course module ID.
  44       * @param bool $seb Whether to use a seb:// scheme or fall back to http:// scheme.
  45       * @param bool $secure Whether to use HTTPS or HTTP protocol.
  46       * @return string A URL.
  47       */
  48      public static function get_link(string $cmid, bool $seb = false, bool $secure = true) : string {
  49          // Check if course module exists.
  50          get_coursemodule_from_id('quiz', $cmid, 0, false, MUST_EXIST);
  51  
  52          $url = new moodle_url('/mod/quiz/accessrule/seb/config.php?cmid=' . $cmid);
  53          if ($seb) {
  54              $secure ? $url->set_scheme('sebs') : $url->set_scheme('seb');
  55          } else {
  56              $secure ? $url->set_scheme('https') : $url->set_scheme('http');
  57          }
  58          return $url->out();
  59      }
  60  }