[Summary view]

Differences Between: [Versions 310 and 402] [Versions 310 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 assignsubmission_file assessable uploaded event.
  19   *
  20   * @package    assignsubmission_file
  21   * @copyright  2013 Frédéric Massart
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace assignsubmission_file\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The assignsubmission_file assessable uploaded event class.
  31   *
  32   * @package    assignsubmission_file
  33   * @since      Moodle 2.6
  34   * @copyright  2013 Frédéric Massart
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class assessable_uploaded extends \core\event\assessable_uploaded {
  38  
  39      /**
  40       * Legacy event files.
  41       *
  42       * @var array
  43       */
  44      protected $legacyfiles = array();
  45  
  46      /**
  47       * Returns description of what happened.
  48       *
  49       * @return string
  50       */
  51      public function get_description() {
  52          return "The user with id '$this->userid' has uploaded a file to the submission with id '$this->objectid' " .
  53              "in the assignment activity with course module id '$this->contextinstanceid'.";
  54      }
  55  
  56      /**
  57       * Legacy event data if get_legacy_eventname() is not empty.
  58       *
  59       * @return \stdClass
  60       */
  61      protected function get_legacy_eventdata() {
  62          $eventdata = new \stdClass();
  63          $eventdata->modulename = 'assign';
  64          $eventdata->cmid = $this->contextinstanceid;
  65          $eventdata->itemid = $this->objectid;
  66          $eventdata->courseid = $this->courseid;
  67          $eventdata->userid = $this->userid;
  68          if (count($this->legacyfiles) > 1) {
  69              $eventdata->files = $this->legacyfiles;
  70          }
  71          $eventdata->file = $this->legacyfiles;
  72          $eventdata->pathnamehashes = array_keys($this->legacyfiles);
  73          return $eventdata;
  74      }
  75  
  76      /**
  77       * Return the legacy event name.
  78       *
  79       * @return string
  80       */
  81      public static function get_legacy_eventname() {
  82          return 'assessable_file_uploaded';
  83      }
  84  
  85      /**
  86       * Return localised event name.
  87       *
  88       * @return string
  89       */
  90      public static function get_name() {
  91          return get_string('eventassessableuploaded', 'assignsubmission_file');
  92      }
  93  
  94      /**
  95       * Get URL related to the action.
  96       *
  97       * @return \moodle_url
  98       */
  99      public function get_url() {
 100          return new \moodle_url('/mod/assign/view.php', array('id' => $this->contextinstanceid));
 101      }
 102  
 103      /**
 104       * Sets the legacy event data.
 105       *
 106       * @param stdClass $legacyfiles legacy event data.
 107       * @return void
 108       */
 109      public function set_legacy_files($legacyfiles) {
 110          $this->legacyfiles = $legacyfiles;
 111      }
 112  
 113      /**
 114       * Init method.
 115       *
 116       * @return void
 117       */
 118      protected function init() {
 119          parent::init();
 120          $this->data['objecttable'] = 'assign_submission';
 121      }
 122  
 123      public static function get_objectid_mapping() {
 124          return array('db' => 'assign_submission', 'restore' => 'submission');
 125      }
 126  }