[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   * Group assigned to grouping event.
  19   *
  20   * @package    core
  21   * @copyright  2016 Vadim Dvorovenko
  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   * Group assigned to grouping event class.
  30   *
  31   * @package    core
  32   * @since      Moodle 3.1
  33   * @copyright  2016 Vadim Dvorovenko
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class grouping_group_assigned extends base {
  37  
  38      /**
  39       * Returns description of what happened.
  40       *
  41       * @return string
  42       */
  43      public function get_description() {
  44          return "The user with id '$this->userid' assigned the group with id '{$this->other['groupid']}'" .
  45                  " to the grouping with id '$this->objectid'.";
  46      }
  47  
  48      /**
  49       * Return localised event name.
  50       *
  51       * @return string
  52       */
  53      public static function get_name() {
  54          return get_string('eventgroupinggroupassigned', 'group');
  55      }
  56  
  57      /**
  58       * Get URL related to the action.
  59       *
  60       * @return \moodle_url
  61       */
  62      public function get_url() {
  63          return new \moodle_url('/group/assign.php', array('id' => $this->objectid));
  64      }
  65  
  66      /**
  67       * Init method.
  68       *
  69       * @return void
  70       */
  71      protected function init() {
  72          $this->data['crud'] = 'c';
  73          $this->data['edulevel'] = self::LEVEL_OTHER;
  74          $this->data['objecttable'] = 'groupings';
  75      }
  76  
  77      /**
  78       * This is used when restoring course logs where it is required that we
  79       * map the objectid to its new value in the new course.
  80       *
  81       * @return string the name of the restore mapping the objectid links to
  82       */
  83      public static function get_objectid_mapping() {
  84          return array('db' => 'groupings', 'restore' => 'group');
  85      }
  86  
  87      /**
  88       * This is used when restoring course logs where it is required that we
  89       * map the information in 'other' to its new value in the new course.
  90       *
  91       * @return array an array of other values and their corresponding mapping
  92       */
  93      public static function get_other_mapping() {
  94          $othermapped = array();
  95          $othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
  96          return $othermapped;
  97      }
  98  }