[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   * Cohort updated event.
  19   *
  20   * @package    core
  21   * @copyright  2013 Dan Poltawski <dan@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core\event;
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  /**
  29   * Cohort created event class.
  30   *
  31   * @package    core
  32   * @since      Moodle 2.6
  33   * @copyright  2013 Dan Poltawski <dan@moodle.com>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class cohort_created extends base {
  37  
  38      /**
  39       * Init method.
  40       *
  41       * @return void
  42       */
  43      protected function init() {
  44          $this->data['crud'] = 'c';
  45          $this->data['edulevel'] = self::LEVEL_OTHER;
  46          $this->data['objecttable'] = 'cohort';
  47      }
  48  
  49      /**
  50       * Returns localised general event name.
  51       *
  52       * @return string
  53       */
  54      public static function get_name() {
  55          return get_string('eventcohortcreated', 'core_cohort');
  56      }
  57  
  58      /**
  59       * Returns description of what happened.
  60       *
  61       * @return string
  62       */
  63      public function get_description() {
  64          return "The user with id '$this->userid' created the cohort with id '$this->objectid'.";
  65      }
  66  
  67      /**
  68       * Returns relevant URL.
  69       *
  70       * @return \moodle_url
  71       */
  72      public function get_url() {
  73          return new \moodle_url('/cohort/index.php', array('contextid' => $this->contextid));
  74      }
  75  
  76      /**
  77       * Return legacy event name.
  78       *
  79       * @return string legacy event name
  80       */
  81      public static function get_legacy_eventname() {
  82          return 'cohort_added';
  83      }
  84  
  85      /**
  86       * Return legacy event data.
  87       *
  88       * @return \stdClass
  89       */
  90      protected function get_legacy_eventdata() {
  91          return $this->get_record_snapshot('cohort', $this->objectid);
  92      }
  93  
  94      public static function get_objectid_mapping() {
  95          // Cohorts are not included in backups, so no mapping is needed for restore.
  96          return array('db' => 'cohort', 'restore' => base::NOT_MAPPED);
  97      }
  98  }