[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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_workshop submission deleted event.
  19   *
  20   * @package    mod_workshop
  21   * @copyright  2015 Paul Nicholls
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_workshop\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_workshop submission deleted event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about the event.
  33   *
  34   *      - string submissiontitle: (optional) Submission title.
  35   * }
  36   *
  37   * @package    mod_workshop
  38   * @since      Moodle 3.1
  39   * @copyright  2015 Paul Nicholls
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class submission_deleted extends \core\event\base {
  43  
  44      /**
  45       * Init method.
  46       */
  47      protected function init() {
  48          $this->data['crud'] = 'd';
  49          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  50          $this->data['objecttable'] = 'workshop_submissions';
  51      }
  52  
  53      /**
  54       * Returns non-localised description of what happened.
  55       *
  56       * @return string
  57       */
  58      public function get_description() {
  59          return "The user with id '$this->userid' deleted the submission with id '$this->objectid' for the workshop " .
  60              "with course module id '$this->contextinstanceid'.";
  61      }
  62  
  63      /**
  64       * Returns localised general event name.
  65       *
  66       * @return string
  67       */
  68      public static function get_name() {
  69          return get_string('eventsubmissiondeleted', 'workshop');
  70      }
  71  
  72      /**
  73       * Returns relevant URL.
  74       *
  75       * @return \moodle_url
  76       */
  77      public function get_url() {
  78          return new \moodle_url('/mod/workshop/submission.php',
  79                  array('cmid' => $this->contextinstanceid, 'id' => $this->objectid));
  80      }
  81  
  82      /**
  83       * Replace add_to_log() statement.
  84       *
  85       * @return array of parameters to be passed to legacy add_to_log() function.
  86       */
  87      protected function get_legacy_logdata() {
  88          return array($this->courseid, 'workshop', 'delete submission',
  89              'submission.php?cmid=' . $this->contextinstanceid . '&id=' . $this->objectid,
  90              $this->objectid, $this->contextinstanceid);
  91      }
  92  
  93      /**
  94       * Defines mapping of the 'objectid' property when restoring course logs.
  95       *
  96       * @return array
  97       */
  98      public static function get_objectid_mapping() {
  99          return array('db' => 'workshop_submissions', 'restore' => 'workshop_submission');
 100      }
 101  
 102      /**
 103       * Defines mapping of the 'other' property when restoring course logs.
 104       *
 105       * @return array|bool
 106       */
 107      public static function get_other_mapping() {
 108          // Nothing to map.
 109          return false;
 110      }
 111  }