[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   * Message contact removed event.
  19   *
  20   * @package    core
  21   * @copyright  2014 Mark Nelson <markn@moodle.com>
  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   * Message contact removed event class.
  31   *
  32   * @package    core
  33   * @since      Moodle 2.7
  34   * @copyright  2014 Mark Nelson <markn@moodle.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class message_contact_removed extends base {
  38  
  39      /**
  40       * Init method.
  41       */
  42      protected function init() {
  43          $this->data['objecttable'] = 'message_contacts';
  44          $this->data['crud'] = 'd';
  45          $this->data['edulevel'] = self::LEVEL_OTHER;
  46      }
  47  
  48      /**
  49       * Returns localised general event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventmessagecontactremoved', 'message');
  55      }
  56  
  57      /**
  58       * Returns relevant URL.
  59       *
  60       * @return \moodle_url
  61       */
  62      public function get_url() {
  63          return new \moodle_url('/message/index.php', array('user1' => $this->userid, 'user2' => $this->relateduserid));
  64      }
  65  
  66      /**
  67       * Returns description of what happened.
  68       *
  69       * @return string
  70       */
  71      public function get_description() {
  72          return "The user with id '$this->userid' removed the user with id '$this->relateduserid' from their contact list.";
  73      }
  74  
  75      /**
  76       * Return legacy data for add_to_log().
  77       *
  78       * @return array
  79       */
  80      protected function get_legacy_logdata() {
  81          return array(SITEID, 'message', 'remove contact', 'index.php?user1=' . $this->relateduserid . '&amp;user2=' .
  82              $this->userid, $this->relateduserid);
  83      }
  84  
  85      /**
  86       * Custom validation.
  87       *
  88       * @throws \coding_exception
  89       */
  90      protected function validate_data() {
  91          parent::validate_data();
  92  
  93          if (!isset($this->relateduserid)) {
  94              throw new \coding_exception('The \'relateduserid\' must be set.');
  95          }
  96      }
  97  
  98      public static function get_objectid_mapping() {
  99          // Messaging contacts are not backed up, so no need to map them on restore.
 100          return array('db' => 'message_contacts', 'restore' => base::NOT_MAPPED);
 101      }
 102  }