[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   * Event for when a new note entry is added.
  19   *
  20   * @package    core
  21   * @copyright  2013 Ankit Agarwal
  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   * Class note_created
  31   *
  32   * Class for event to be triggered when a note is created.
  33   *
  34   * @property-read array $other {
  35   *      Extra information about event.
  36   *
  37   *      - string publishstate: (optional) the publish state.
  38   * }
  39   *
  40   * @package    core
  41   * @since      Moodle 2.6
  42   * @copyright  2013 Ankit Agarwal
  43   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  44   */
  45  class note_created extends base {
  46  
  47      /**
  48       * Set basic properties for the event.
  49       */
  50      protected function init() {
  51          $this->data['objecttable'] = 'post';
  52          $this->data['crud'] = 'c';
  53          $this->data['edulevel'] = self::LEVEL_OTHER;
  54      }
  55  
  56      /**
  57       * Returns localised general event name.
  58       *
  59       * @return string
  60       */
  61      public static function get_name() {
  62          return get_string("eventnotecreated", "core_notes");
  63      }
  64  
  65      /**
  66       * Returns non-localised event description with id's for admin use only.
  67       *
  68       * @return string
  69       */
  70      public function get_description() {
  71          return "The user with id '$this->userid' created the note with id '$this->objectid' for the user with id " .
  72              "'$this->relateduserid'.";
  73      }
  74  
  75      /**
  76       * Returns relevant URL.
  77       * @return \moodle_url
  78       */
  79      public function get_url() {
  80          $logurl = new \moodle_url('/notes/index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
  81          $logurl->set_anchor('note-' . $this->objectid);
  82          return $logurl;
  83      }
  84  
  85      /**
  86       * replace add_to_log() statement.
  87       *
  88       * @return array of parameters to be passed to legacy add_to_log() function.
  89       */
  90      protected function get_legacy_logdata() {
  91          $logurl = new \moodle_url('index.php', array('course' => $this->courseid, 'user' => $this->relateduserid));
  92          $logurl->set_anchor('note-' . $this->objectid);
  93          return array($this->courseid, 'notes', 'add', $logurl, 'add note');
  94      }
  95  
  96      /**
  97       * Custom validation.
  98       *
  99       * @throws \coding_exception
 100       * @return void
 101       */
 102      protected function validate_data() {
 103          parent::validate_data();
 104  
 105          if (!isset($this->relateduserid)) {
 106              throw new \coding_exception('The \'relateduserid\' must be set.');
 107          }
 108      }
 109  
 110      public static function get_objectid_mapping() {
 111          // Notes are not backed up, so no need to map on restore.
 112          return array('db' => 'post', 'restore' => base::NOT_MAPPED);
 113      }
 114  
 115      public static function get_other_mapping() {
 116          // Nothing to map.
 117          return false;
 118      }
 119  }