[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   * User removed from a cohort 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   * User removed from a cohort 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  
  37  class cohort_member_removed extends base {
  38  
  39      /**
  40       * Init method.
  41       *
  42       * @return void
  43       */
  44      protected function init() {
  45          $this->data['crud'] = 'd';
  46          $this->data['edulevel'] = self::LEVEL_OTHER;
  47          $this->data['objecttable'] = 'cohort';
  48      }
  49  
  50      /**
  51       * Returns localised general event name.
  52       *
  53       * @return string
  54       */
  55      public static function get_name() {
  56          return get_string('eventcohortmemberremoved', 'core_cohort');
  57      }
  58  
  59      /**
  60       * Returns description of what happened.
  61       *
  62       * @return string
  63       */
  64      public function get_description() {
  65          return "The user with id '$this->userid' removed the user with id '$this->relateduserid' from the cohort with " .
  66              "id '$this->objectid'.";
  67      }
  68  
  69      /**
  70       * Returns relevant URL.
  71       *
  72       * @return \moodle_url
  73       */
  74      public function get_url() {
  75          return new \moodle_url('/cohort/assign.php', array('id' => $this->objectid));
  76      }
  77  
  78      /**
  79       * Return legacy event name.
  80       *
  81       * @return string legacy event name.
  82       */
  83      public static function get_legacy_eventname() {
  84          return 'cohort_member_removed';
  85      }
  86  
  87      /**
  88       * Return legacy event data.
  89       *
  90       * @return \stdClass
  91       */
  92      protected function get_legacy_eventdata() {
  93          $data = new \stdClass();
  94          $data->cohortid = $this->objectid;
  95          $data->userid = $this->relateduserid;
  96          return $data;
  97      }
  98  
  99      /**
 100       * Custom validations.
 101       *
 102       * @throws \coding_exception
 103       * @return void
 104       */
 105      protected function validate_data() {
 106          parent::validate_data();
 107  
 108          if (!isset($this->relateduserid)) {
 109              throw new \coding_exception('The \'relateduserid\' must be set.');
 110          }
 111      }
 112  
 113      public static function get_objectid_mapping() {
 114          // Cohorts are not included in backups, so no mapping is needed for restore.
 115          return array('db' => 'cohort', 'restore' => base::NOT_MAPPED);
 116      }
 117  }