[Summary view] [Print] [Text 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   * Course module completion event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Rajesh Taneja <[email protected]>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * Course module completion event class.
  31   *
  32   * @package    core
  33   * @since      Moodle 2.6
  34   * @copyright  2013 Rajesh Taneja <[email protected]>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class course_module_completion_updated extends base {
  38  
  39      /**
  40       * Initialise required event data properties.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'course_modules_completion';
  44          $this->data['crud'] = 'u';
  45          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  46      }
  47  
  48      /**
  49       * Returns localised event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventcoursemodulecompletionupdated', 'core_completion');
  55      }
  56  
  57      /**
  58       * Returns non-localised event description with id's for admin use only.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' updated the completion state for the course module with id '$this->contextinstanceid' " .
  64              "for the user with id '$this->relateduserid'.";
  65      }
  66  
  67      /**
  68       * Returns relevant URL.
  69       *
  70       * @return \moodle_url
  71       */
  72      public function get_url() {
  73          return new \moodle_url('/report/completion/index.php', array('course' => $this->courseid));
  74      }
  75  
  76      /**
  77       * Return name of the legacy event, which is replaced by this event.
  78       *
  79       * @return string legacy event name
  80       */
  81      public static function get_legacy_eventname() {
  82          return 'activity_completion_changed';
  83      }
  84  
  85      /**
  86       * Return course module completion legacy event data.
  87       *
  88       * @return \stdClass completion data.
  89       */
  90      protected function get_legacy_eventdata() {
  91          return $this->get_record_snapshot('course_modules_completion', $this->objectid);
  92      }
  93  
  94      /**
  95       * Custom validation.
  96       *
  97       * @throws \coding_exception in case of a problem.
  98       */
  99      protected function validate_data() {
 100          parent::validate_data();
 101          // Make sure the context level is set to module.
 102          if ($this->contextlevel !== CONTEXT_MODULE) {
 103              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 104          }
 105  
 106          if (!isset($this->relateduserid)) {
 107              throw new \coding_exception('The \'relateduserid\' must be set.');
 108          }
 109      }
 110  }