lib/classes/event/cohort_member_added.php

   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 added to 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 added to 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 class cohort_member_added 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('eventcohortmemberadded', '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' added the user with id '$this->relateduserid' to the cohort with " .
  65             "id '$this->objectid'.";
  66     }
  67
  68     /**
  69      * Returns relevant URL.
  70      *
  71      * @return \moodle_url
  72      */
  73     public function get_url() {
  74         return new \moodle_url('/cohort/assign.php', array('id' => $this->objectid));
  75     }
  76
  77     /**
  78      * Return legacy event name.
  79      *
  80      * @return string legacy event name.
  81      */
  82     public static function get_legacy_eventname() {
  83         return 'cohort_member_added';
  84     }
  85
  86     /**
  87      * Return legacy event data.
  88      *
  89      * @return \stdClass
  90      */
  91     protected function get_legacy_eventdata() {
  92         $data = new \stdClass();
  93         $data->cohortid = $this->objectid;
  94         $data->userid = $this->relateduserid;
  95         return $data;
  96     }
  97
  98     /**
  99      * Custom validations.
 100      *
 101      * @throws \coding_exception
 102      * @return void
 103      */
 104     protected function validate_data() {
 105         parent::validate_data();
 106
 107         if (!isset($this->relateduserid)) {
 108             throw new \coding_exception('The \'relateduserid\' must be set.');
 109         }
 110     }
 111
 112     public static function get_objectid_mapping() {
 113         // Cohorts are not included in backups, so no mapping is needed for restore.
 114         return array('db' => 'cohort', 'restore' => base::NOT_MAPPED);
 115     }
 116 }