mirror of
https://github.com/moodle/moodle.git
synced 2025-03-04 08:06:30 +01:00
861b0510e5
This combines the following changes:
* Event for group member added
* Event for group member removed
* Event for group created
* Event for grouping created
* Event for group updated
* Event for grouping updated
* Event for group deleted
* Event for grouping deleted
* Adding tests for deleting functions
* Bulk remove of members uses low-level API
The reason for this is that a bulk event has no value from a logging
perspective as it is not granular. So now, the API is a bit slower,
but the information the events contain makes sense, beside this is
not (and should not be) used very often.
The reason why the events_trigger_legacy() is kept is because we
cannot create a new event for this, as we don't encourage developers
to created bulk events, for the reasons mentioned above.
I removed the call that gets the user record from the function
groups_remove_member() as it was not required and only appeared
to check if the user existed. It appears to be safe not to do
this check as nothing would fail down the line.
* Bulk unassign of groupings uses low-level API
As the previous commit, we keep the legacy event for now as it would
be wrong to create a new event to replace it.
Also, the code has been changed to call the low-level API to unassign
groups from groupins, even though at the moment there are no
events for that function.
* Bulk deletion of groups uses low-level API
Again, we keep the legacy event because replacing it would force
us to create a new event that does not make sense. See MDL-41312.
* Bulk deleting of groupings uses low-level API
* Asserting legacy event name in unit tests
* Minor SQL query and code improvements
111 lines
3.0 KiB
PHP
111 lines
3.0 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* core_group member added event.
|
|
*
|
|
* @package core_group
|
|
* @copyright 2013 Frédéric Massart
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core\event;
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* core_group member added event class.
|
|
*
|
|
* @package core_group
|
|
* @copyright 2013 Frédéric Massart
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class group_member_added extends \core\event\base {
|
|
|
|
/**
|
|
* Returns description of what happened.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function get_description() {
|
|
return "User {$this->userid} added user {$this->relateduserid} to group {$this->objectid}.";
|
|
}
|
|
|
|
/**
|
|
* Legacy event data if get_legacy_eventname() is not empty.
|
|
*
|
|
* @return stdClass
|
|
*/
|
|
protected function get_legacy_eventdata() {
|
|
$eventdata = new \stdClass();
|
|
$eventdata->groupid = $this->objectid;
|
|
$eventdata->userid = $this->relateduserid;
|
|
$eventdata->component = $this->other['component'];
|
|
$eventdata->itemid = $this->other['itemid'];
|
|
return $eventdata;
|
|
}
|
|
|
|
/**
|
|
* Return the legacy event name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_legacy_eventname() {
|
|
return 'groups_member_added';
|
|
}
|
|
|
|
/**
|
|
* Return localised event name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function get_name() {
|
|
return get_string('event_group_member_added', 'group');
|
|
}
|
|
|
|
/**
|
|
* Get URL related to the action
|
|
*
|
|
* @return \moodle_url
|
|
*/
|
|
public function get_url() {
|
|
return new \moodle_url('/group/index.php', array('id' => $this->courseid));
|
|
}
|
|
|
|
/**
|
|
* Init method.
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function init() {
|
|
$this->data['crud'] = 'c';
|
|
$this->data['level'] = self::LEVEL_OTHER;
|
|
$this->data['objecttable'] = 'groups';
|
|
}
|
|
|
|
/**
|
|
* Custom validation.
|
|
*
|
|
* @throws \coding_exception
|
|
* @return void
|
|
*/
|
|
protected function validate_data() {
|
|
if (!isset($this->other['component']) || !isset($this->other['itemid'])) {
|
|
throw new \coding_exception('The component and itemid need to be set in $other, even if empty.');
|
|
}
|
|
}
|
|
|
|
}
|