[Summary view]

Differences Between: [Versions 311 and 402] [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_lesson essay assessed event.
  19   *
  20   * @package    mod_lesson
  21   * @copyright  2014 Adrian Greeve <adrian@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_lesson\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_lesson essay assessed event class.
  31   *
  32   * @property-read array $other {
  33   *     Extra information about the event.
  34   *
  35   *     - int lessonid: The ID of the lesson.
  36   *     - int attemptid: The ID for the attempt.
  37   * }
  38   *
  39   * @package    mod_lesson
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Adrian Greeve <adrian@moodle.com>
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class essay_assessed extends \core\event\base {
  45  
  46      /**
  47       * Init method.
  48       *
  49       * @return void
  50       */
  51      protected function init() {
  52          $this->data['crud'] = 'u';
  53          $this->data['edulevel'] = self::LEVEL_TEACHING;
  54          $this->data['objecttable'] = 'lesson_grades';
  55      }
  56  
  57      /**
  58       * Returns description of what happened.
  59       *
  60       * @return string
  61       */
  62      public function get_description() {
  63          return "The user with id '$this->userid' has marked the essay with id '{$this->other['attemptid']}' and " .
  64              "recorded a mark '$this->objectid' in the lesson with course module id '$this->contextinstanceid'.";
  65      }
  66  
  67      /**
  68       * Return legacy data for add_to_log().
  69       *
  70       * @return array
  71       */
  72      protected function get_legacy_logdata() {
  73          $lesson = $this->get_record_snapshot('lesson', $this->other['lessonid']);
  74          return array($this->courseid, 'lesson', 'update grade', 'essay.php?id=' .
  75                  $this->contextinstanceid, $lesson->name, $this->contextinstanceid);
  76      }
  77  
  78      /**
  79       * Return localised event name.
  80       *
  81       * @return string
  82       */
  83      public static function get_name() {
  84          return get_string('eventessayassessed', 'mod_lesson');
  85      }
  86  
  87      /**
  88       * Get URL related to the action
  89       *
  90       * @return \moodle_url
  91       */
  92      public function get_url() {
  93          return new \moodle_url('/mod/lesson/essay.php', array('id' => $this->contextinstanceid));
  94      }
  95  
  96      /**
  97       * Custom validation.
  98       *
  99       * @throws \coding_exception
 100       * @return void
 101       */
 102      protected function validate_data() {
 103          parent::validate_data();
 104          if (!isset($this->relateduserid)) {
 105              throw new \coding_exception('The \'relateduserid\' must be set.');
 106          }
 107          if (!isset($this->other['lessonid'])) {
 108              throw new \coding_exception('The \'lessonid\' value must be set in other.');
 109          }
 110          if (!isset($this->other['attemptid'])) {
 111              throw new \coding_exception('The \'attemptid\' value must be set in other.');
 112          }
 113      }
 114  
 115      public static function get_objectid_mapping() {
 116          return array('db' => 'lesson_grades', 'restore' => 'lesson_grade');
 117      }
 118  
 119      public static function get_other_mapping() {
 120          $othermapped = array();
 121          $othermapped['lessonid'] = array('db' => 'lesson', 'restore' => 'lesson');
 122          $othermapped['attemptid'] = array('db' => 'lesson_attempts', 'restore' => 'lesson_attept');
 123  
 124          return $othermapped;
 125      }
 126  }