[Summary view]

Differences Between: [Versions 311 and 403]

   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   * The mod_scorm generic CMI element submitted event.
  19   *
  20   * @package    mod_scorm
  21   * @copyright  2016 onwards Matteo Scaramuccia
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_scorm\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_scorm generic CMI element submitted event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event properties.
  33   *
  34   *      - int attemptid: Attempt id.
  35   *      - string cmielement: CMI element.
  36   *      - string cmivalue: CMI value.
  37   * }
  38   *
  39   * @package    mod_scorm
  40   * @since      Moodle 3.1
  41   * @copyright  2016 onwards Matteo Scaramuccia
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  abstract class cmielement_submitted extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       */
  49      protected function init() {
  50          $this->data['crud'] = 'u';
  51          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  52          $this->data['objecttable'] = 'scorm_scoes_track';
  53      }
  54  
  55      /**
  56       * Returns non-localised description of what happened.
  57       *
  58       * @return string
  59       */
  60      public function get_description() {
  61          return "The user with the id '$this->userid' submitted the element '{$this->other['cmielement']}' " .
  62                  "with the value of '{$this->other['cmivalue']}' " .
  63                  "for the attempt with the id '{$this->other['attemptid']}' " .
  64                  "for a scorm activity with the course module id '$this->contextinstanceid'.";
  65      }
  66  
  67      /**
  68       * Get URL related to the action
  69       *
  70       * @return \moodle_url
  71       */
  72      public function get_url() {
  73          return new \moodle_url('/mod/scorm/report/userreport.php',
  74                  array('id' => $this->contextinstanceid, 'user' => $this->userid, 'attempt' => $this->other['attemptid']));
  75      }
  76  
  77      /**
  78       * Custom validation.
  79       *
  80       * @throws \coding_exception
  81       * @return void
  82       */
  83      protected function validate_data() {
  84          parent::validate_data();
  85  
  86          if (empty($this->other['attemptid'])) {
  87              throw new \coding_exception("The 'attemptid' must be set in other.");
  88          }
  89  
  90          if (empty($this->other['cmielement'])) {
  91              throw new \coding_exception("The 'cmielement' must be set in other.");
  92          }
  93          // Trust that 'cmielement' represents a valid CMI datamodel element:
  94          // just check that the given value starts with 'cmi.'.
  95          if (strpos($this->other['cmielement'], 'cmi.', 0) !== 0) {
  96              throw new \coding_exception(
  97                  "A valid 'cmielement' must start with 'cmi.' ({$this->other['cmielement']}).");
  98          }
  99  
 100          // Warning: 'cmivalue' could be also "0" e.g. when 'cmielement' represents a score.
 101          if (!isset($this->other['cmivalue'])) {
 102              throw new \coding_exception("The 'cmivalue' must be set in other.");
 103          }
 104      }
 105  }