[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 attempt viewed event.
  19   *
  20   * @package    mod_lesson
  21   * @copyright  2013 Mark Nelson <markn@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 attempt viewed event class.
  31   *
  32   * @package    mod_lesson
  33   * @since      Moodle 2.7
  34   * @copyright  2013 Mark Nelson <markn@moodle.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  36   */
  37  class essay_attempt_viewed extends \core\event\base {
  38  
  39      /**
  40       * Set basic properties for the event.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'lesson_attempts';
  44          $this->data['crud'] = 'r';
  45          $this->data['edulevel'] = self::LEVEL_TEACHING;
  46      }
  47  
  48      /**
  49       * Returns localised general event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventessayattemptviewed', 'mod_lesson');
  55      }
  56  
  57      /**
  58       * Get URL related to the action.
  59       *
  60       * @return \moodle_url
  61       */
  62      public function get_url() {
  63          return new \moodle_url('/mod/lesson/essay.php', array('id' => $this->contextinstanceid,
  64              'mode' => 'grade', 'attemptid' =>  $this->objectid));
  65      }
  66  
  67      /**
  68       * Returns non-localised event description with id's for admin use only.
  69       *
  70       * @return string
  71       */
  72      public function get_description() {
  73          return "The user with id '$this->userid' viewed the essay grade for the user with id '$this->relateduserid' for " .
  74              "the attempt with id '$this->objectid' for the lesson activity with course module id '$this->contextinstanceid'.";
  75      }
  76  
  77      /**
  78       * Replace add_to_log() statement.
  79       *
  80       * @return array of parameters to be passed to legacy add_to_log() function.
  81       */
  82      protected function get_legacy_logdata() {
  83          return array($this->courseid, 'lesson', 'view grade', 'essay.php?id=' . $this->contextinstanceid . '&mode=grade&attemptid='
  84              . $this->objectid, get_string('manualgrading', 'lesson'), $this->contextinstanceid);
  85      }
  86  
  87      /**
  88       * Custom validation.
  89       *
  90       * @throws \coding_exception
  91       * @return void
  92       */
  93      protected function validate_data() {
  94          parent::validate_data();
  95  
  96          if (!isset($this->relateduserid)) {
  97              throw new \coding_exception('The \'relateduserid\' must be set.');
  98          }
  99      }
 100  
 101      public static function get_objectid_mapping() {
 102          return array('db' => 'lesson_attempts', 'restore' => 'lesson_attempt');
 103      }
 104  }