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