mod/scorm/report/default.php

   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  * @package    mod_scorm
  18  * @author     Ankit Kumar Agarwal
  19  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  20  */
  21 ////////////////////////////////////////////////////////////////////
  22 /// Default class for Scorm plugins
  23 ///
  24 /// Doesn't do anything on it's own -- it needs to be extended.
  25 /// This class displays scorm reports.  Because it is called from
  26 /// within /mod/scorm/report.php you can assume that the page header
  27 /// and footer are taken care of.
  28 ///
  29 /// This file can refer to itself as report.php to pass variables
  30 /// to itself - all these will also be globally available.
  31 ////////////////////////////////////////////////////////////////////
  32
  33 defined('MOODLE_INTERNAL') || die();
  34
  35 class scorm_default_report {
  36     /**
  37      * displays the full report
  38      * @param stdClass $scorm full SCORM object
  39      * @param stdClass $cm - full course_module object
  40      * @param stdClass $course - full course object
  41      * @param string $download - type of download being requested
  42      */
  43     function display($scorm, $cm, $course, $download) {
  44         /// This function just displays the report
  45         return true;
  46     }
  47     /**
  48      * allows the plugin to control who can see this plugin.
  49      * @return boolean
  50      */
  51     function canview($contextmodule) {
  52         return true;
  53     }
  54 }