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