lib/classes/event/grade_letter_updated.php

   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  * Grade letter updated event.
  19  *
  20  * @package    core
  21  * @copyright  2017 Stephen Bourget
  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  * Grade letter updated event class.
  31  *
  32  * @package    core
  33  * @since      Moodle 3.5
  34  * @copyright  2017 Stephen Bourget
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 class grade_letter_updated extends base {
  38
  39     /**
  40      * Init method.
  41      *
  42      * @return void
  43      */
  44     protected function init() {
  45         $this->data['objecttable'] = 'grade_letters';
  46         $this->data['crud'] = 'u';
  47         $this->data['edulevel'] = self::LEVEL_OTHER;
  48     }
  49
  50     /**
  51      * Return localised event name.
  52      *
  53      * @return string
  54      */
  55     public static function get_name() {
  56         return get_string('eventgradeletterupdated', 'core_grades');
  57     }
  58
  59     /**
  60      * Returns description of what happened.
  61      *
  62      * @return string
  63      */
  64     public function get_description() {
  65         if ($this->courseid) {
  66             return "The user with id '$this->userid' updated the letter grade with id '$this->objectid'".
  67                     " in the course with the id '".$this->courseid."'.";
  68         } else {
  69             return "The user with id '$this->userid' updated the letter grade with id '$this->objectid'.";
  70         }
  71     }
  72
  73     /**
  74      * Returns relevant URL.
  75      *
  76      * @return \moodle_url
  77      */
  78     public function get_url() {
  79         $url = new \moodle_url('/grade/edit/letter/index.php');
  80         if ($this->courseid) {
  81             $url->param('id', $this->contextid);
  82         }
  83         return $url;
  84     }
  85
  86     /**
  87      * Used for mapping events on restore
  88      *
  89      * @return array
  90      */
  91     public static function get_objectid_mapping() {
  92         return array('db' => 'grade_letters', 'restore' => 'grade_letters');
  93     }
  94
  95 }