[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   * The mod_glossary entry deleted event.
  19   *
  20   * @package    mod_glossary
  21   * @copyright  2014 Marina Glancy
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_glossary\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * The mod_glossary entry deleted event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string concept: (optional) the concept of deleted entry.
  35   *      - string mode: (optional) view mode user was in before deleting entry.
  36   *      - int|string hook: (optional) hook parameter in the previous view mode.
  37   * }
  38   *
  39   * @package    mod_glossary
  40   * @since      Moodle 2.7
  41   * @copyright  2014 Marina Glancy
  42   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  43   */
  44  class entry_deleted extends \core\event\base {
  45      /**
  46       * Init method
  47       */
  48      protected function init() {
  49          $this->data['crud'] = 'd';
  50          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  51          $this->data['objecttable'] = 'glossary_entries';
  52      }
  53  
  54      /**
  55       * Returns localised general event name.
  56       *
  57       * @return string
  58       */
  59      public static function get_name() {
  60          return get_string('evententrydeleted', 'mod_glossary');
  61      }
  62  
  63      /**
  64       * Returns non-localised event description with id's for admin use only.
  65       *
  66       * @return string
  67       */
  68      public function get_description() {
  69          return "The user with id '$this->userid' has deleted the glossary entry with id '$this->objectid' in " .
  70              "the glossary activity with course module id '$this->contextinstanceid'.";
  71      }
  72  
  73      /**
  74       * Get URL related to the action.
  75       *
  76       * @return \moodle_url
  77       */
  78      public function get_url() {
  79          // Entry does not exist any more, returning link to the module view page in the mode it was before deleting entry.
  80          $params = array('id' => $this->contextinstanceid);
  81          if (isset($this->other['hook'])) {
  82              $params['hook'] = $this->other['hook'];
  83          }
  84          if (isset($this->other['mode'])) {
  85              $params['mode'] = $this->other['mode'];
  86          }
  87          return new \moodle_url("/mod/glossary/view.php", $params);
  88      }
  89  
  90      /**
  91       * Return the legacy event log data.
  92       *
  93       * @return array|null
  94       */
  95      public function get_legacy_logdata() {
  96          $hook = $mode = '';
  97          if (isset($this->other['hook'])) {
  98              $hook = $this->other['hook'];
  99          }
 100          if (isset($this->other['mode'])) {
 101              $mode = $this->other['mode'];
 102          }
 103          return array($this->courseid, 'glossary', 'delete entry',
 104              "view.php?id={$this->contextinstanceid}&amp;mode={$mode}&amp;hook={$hook}",
 105              $this->objectid, $this->contextinstanceid);
 106      }
 107  
 108      /**
 109       * Custom validation.
 110       *
 111       * @throws \coding_exception
 112       * @return void
 113       */
 114      protected function validate_data() {
 115          parent::validate_data();
 116          // Make sure this class is never used without proper object details.
 117          if (!$this->contextlevel === CONTEXT_MODULE) {
 118              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 119          }
 120      }
 121  
 122      public static function get_objectid_mapping() {
 123          return array('db' => 'glossary_entries', 'restore' => 'glossary_entry');
 124      }
 125  
 126      public static function get_other_mapping() {
 127          // Nothing to map.
 128          return false;
 129      }
 130  }
 131