[Summary view]

   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_folder course module downloaded event.
  19   *
  20   * @package   mod_folder
  21   * @copyright 2015 Andrew Hancox <andrewdchancox@googlemail.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_folder\event;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The mod_folder course module viewed event class.
  31   *
  32   * @package    mod_folder
  33   * @since      Moodle 3.1
  34   * @copyright  2015 Andrew Hancox <andrewdchancox@googlemail.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class all_files_downloaded extends \core\event\base {
  38  
  39      /**
  40       * Init method.
  41       *
  42       * @return void
  43       */
  44      protected function init() {
  45          $this->data['crud'] = 'r';
  46          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  47          $this->data['objecttable'] = 'folder';
  48      }
  49  
  50      /**
  51       * Returns description of what happened.
  52       *
  53       * @return string
  54       */
  55      public function get_description() {
  56          return "The user with id '$this->userid' downloaded a zip archive containing all the files from the folder activity with " .
  57          "course module id '$this->contextinstanceid'.";
  58      }
  59  
  60      /**
  61       * Return localised event name.
  62       *
  63       * @return string
  64       */
  65      public static function get_name() {
  66          return get_string('eventallfilesdownloaded', 'folder');
  67      }
  68  
  69      /**
  70       * Get URL related to the action.
  71       *
  72       * @return \moodle_url
  73       */
  74      public function get_url() {
  75          return new \moodle_url("/mod/folder/view.php", array('id' => $this->contextinstanceid));
  76      }
  77  
  78      /**
  79       * Custom validation.
  80       *
  81       * @throws \coding_exception
  82       * @return void
  83       */
  84      protected function validate_data() {
  85          parent::validate_data();
  86          // Make sure this class is never used without proper object details.
  87          if (empty($this->objectid) || empty($this->objecttable)) {
  88              throw new \coding_exception('The course_module_viewed event must define objectid and object table.');
  89          }
  90          // Make sure the context level is set to module.
  91          if ($this->contextlevel != CONTEXT_MODULE) {
  92              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
  93          }
  94      }
  95  }