[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   * Course category updated 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   * Course category updated 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 course_category_updated extends base {
  38  
  39      /** @var array The legacy log data. */
  40      private $legacylogdata;
  41  
  42      /**
  43       * Initialise the event data.
  44       */
  45      protected function init() {
  46          $this->data['objecttable'] = 'course_categories';
  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('eventcoursecategoryupdated');
  58      }
  59  
  60      /**
  61       * Returns relevant URL.
  62       *
  63       * @return \moodle_url
  64       */
  65      public function get_url() {
  66          return new \moodle_url('/course/editcategory.php', array('id' => $this->objectid));
  67      }
  68  
  69      /**
  70       * Returns non-localised description of what happened.
  71       *
  72       * @return string
  73       */
  74      public function get_description() {
  75          return "The user with id '$this->userid' updated the course category with id '$this->objectid'.";
  76      }
  77  
  78      /**
  79       * Set the legacy data used for add_to_log().
  80       *
  81       * @param array $logdata
  82       */
  83      public function set_legacy_logdata($logdata) {
  84          $this->legacylogdata = $logdata;
  85      }
  86  
  87      /**
  88       * Return legacy data for add_to_log().
  89       *
  90       * @return array
  91       */
  92      protected function get_legacy_logdata() {
  93          if (!empty($this->legacylogdata)) {
  94              return $this->legacylogdata;
  95          }
  96  
  97          return array(SITEID, 'category', 'update', 'editcategory.php?id=' . $this->objectid, $this->objectid);
  98      }
  99  
 100      public static function get_objectid_mapping() {
 101          // Categories are not backed up, so no need to map them on restore.
 102          return array('db' => 'course_categories', 'restore' => base::NOT_MAPPED);
 103      }
 104  }