[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 <rajesh@moodle.com>
  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   * @property-read array $other {
  33   *      Extra information about event.
  34   *
  35   *      - int relateduserid: (optional) the related user id.
  36   * }
  37   *
  38   * @package    core
  39   * @since      Moodle 2.6
  40   * @copyright  2013 Rajesh Taneja <rajesh@moodle.com>
  41   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  42   */
  43  class course_module_completion_updated extends base {
  44  
  45      /**
  46       * Initialise required event data properties.
  47       */
  48      protected function init() {
  49          $this->data['objecttable'] = 'course_modules_completion';
  50          $this->data['crud'] = 'u';
  51          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  52      }
  53  
  54      /**
  55       * Returns localised event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('eventcoursemodulecompletionupdated', 'core_completion');
  61      }
  62  
  63      /**
  64       * Returns non-localised event description with id's for admin use only.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->userid' updated the completion state for the course module with id '$this->contextinstanceid' " .
  70              "for the user with id '$this->relateduserid'.";
  71      }
  72  
  73      /**
  74       * Returns relevant URL.
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          return new \moodle_url('/report/completion/index.php', array('course' => $this->courseid));
  80      }
  81  
  82      /**
  83       * Return name of the legacy event, which is replaced by this event.
  84       *
  85       * @return string legacy event name
  86       */
  87      public static function get_legacy_eventname() {
  88          return 'activity_completion_changed';
  89      }
  90  
  91      /**
  92       * Return course module completion legacy event data.
  93       *
  94       * @return \stdClass completion data.
  95       */
  96      protected function get_legacy_eventdata() {
  97          return $this->get_record_snapshot('course_modules_completion', $this->objectid);
  98      }
  99  
 100      /**
 101       * Custom validation.
 102       *
 103       * @throws \coding_exception in case of a problem.
 104       */
 105      protected function validate_data() {
 106          parent::validate_data();
 107          // Make sure the context level is set to module.
 108          if ($this->contextlevel !== CONTEXT_MODULE) {
 109              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 110          }
 111  
 112          if (!isset($this->relateduserid)) {
 113              throw new \coding_exception('The \'relateduserid\' must be set.');
 114          }
 115      }
 116  
 117      public static function get_objectid_mapping() {
 118          // Sorry mapping info is not available for course modules completion records.
 119          return array('db' => 'course_modules_completion', 'restore' => base::NOT_MAPPED);
 120      }
 121  
 122      public static function get_other_mapping() {
 123          $othermapped = array();
 124          $othermapped['relateduserid'] = array('db' => 'user', 'restore' => 'user');
 125  
 126          return $othermapped;
 127      }
 128  }