[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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 created 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 created event class.
  30   *
  31   * @property-read array $other {
  32   *      Extra information about event.
  33   *
  34   *      - string concept: (optional) the concept of created entry.
  35   * }
  36   *
  37   * @package    mod_glossary
  38   * @since      Moodle 2.7
  39   * @copyright  2014 Marina Glancy
  40   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class entry_created extends \core\event\base {
  43      /**
  44       * Init method
  45       */
  46      protected function init() {
  47          $this->data['crud'] = 'c';
  48          $this->data['edulevel'] = self::LEVEL_PARTICIPATING;
  49          $this->data['objecttable'] = 'glossary_entries';
  50      }
  51  
  52      /**
  53       * Returns localised general event name.
  54       *
  55       * @return string
  56       */
  57      public static function get_name() {
  58          return get_string('evententrycreated', 'mod_glossary');
  59      }
  60  
  61      /**
  62       * Returns non-localised event description with id's for admin use only.
  63       *
  64       * @return string
  65       */
  66      public function get_description() {
  67          return "The user with id '$this->userid' has created the glossary entry with id '$this->objectid' for " .
  68              "the glossary activity with course module id '$this->contextinstanceid'.";
  69      }
  70  
  71      /**
  72       * Get URL related to the action.
  73       *
  74       * @return \moodle_url
  75       */
  76      public function get_url() {
  77          return new \moodle_url("/mod/glossary/view.php",
  78                  array('id' => $this->contextinstanceid,
  79                      'mode' => 'entry',
  80                      'hook' => $this->objectid));
  81      }
  82  
  83      /**
  84       * Return the legacy event log data.
  85       *
  86       * @return array|null
  87       */
  88      public function get_legacy_logdata() {
  89          return array($this->courseid, 'glossary', 'add entry',
  90              "view.php?id={$this->contextinstanceid}&amp;mode=entry&amp;hook={$this->objectid}",
  91              $this->objectid, $this->contextinstanceid);
  92      }
  93  
  94      /**
  95       * Custom validation.
  96       *
  97       * @throws \coding_exception
  98       * @return void
  99       */
 100      protected function validate_data() {
 101          parent::validate_data();
 102          // Make sure this class is never used without proper object details.
 103          if (!$this->contextlevel === CONTEXT_MODULE) {
 104              throw new \coding_exception('Context level must be CONTEXT_MODULE.');
 105          }
 106      }
 107  
 108      public static function get_objectid_mapping() {
 109          return array('db' => 'glossary_entries', 'restore' => 'glossary_entry');
 110      }
 111  
 112      public static function get_other_mapping() {
 113          // Nothing to map.
 114          return false;
 115      }
 116  }
 117