Skip to content

Commit

Permalink
MDL-45835 group: events for groupings assign/unassign
Browse files Browse the repository at this point in the history
  • Loading branch information
vadimonus authored and cameorn1730 committed Mar 24, 2016
1 parent fed66ad commit dd399f5
Show file tree
Hide file tree
Showing 4 changed files with 218 additions and 2 deletions.
22 changes: 20 additions & 2 deletions group/lib.php
Original file line number Diff line number Diff line change
Expand Up @@ -837,12 +837,21 @@ function groups_assign_grouping($groupingid, $groupid, $timeadded = null, $inval
}
$DB->insert_record('groupings_groups', $assign);

$courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
if ($invalidatecache) {
// Invalidate the grouping cache for the course
$courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
}

// Trigger event.
$params = array(
'context' => context_course::instance($courseid),
'objectid' => $groupingid,
'other' => array('groupid' => $groupid)
);
$event = \core\event\grouping_group_assigned::create($params);
$event->trigger();

return true;
}

Expand All @@ -858,12 +867,21 @@ function groups_unassign_grouping($groupingid, $groupid, $invalidatecache = true
global $DB;
$DB->delete_records('groupings_groups', array('groupingid'=>$groupingid, 'groupid'=>$groupid));

$courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
if ($invalidatecache) {
// Invalidate the grouping cache for the course
$courseid = $DB->get_field('groupings', 'courseid', array('id' => $groupingid));
cache_helper::invalidate_by_definition('core', 'groupdata', array(), array($courseid));
}

// Trigger event.
$params = array(
'context' => context_course::instance($courseid),
'objectid' => $groupingid,
'other' => array('groupid' => $groupid)
);
$event = \core\event\grouping_group_unassigned::create($params);
$event->trigger();

return true;
}

Expand Down
2 changes: 2 additions & 0 deletions lang/en/group.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@
$string['eventgroupupdated'] = 'Group updated';
$string['eventgroupingcreated'] = 'Grouping created';
$string['eventgroupingdeleted'] = 'Grouping deleted';
$string['eventgroupinggroupassigned'] = 'Group assigned to grouping';
$string['eventgroupinggroupunassigned'] = 'Group unassigned from grouping';
$string['eventgroupingupdated'] = 'Grouping updated';
$string['existingmembers'] = 'Existing members: {$a}';
$string['filtergroups'] = 'Filter groups by:';
Expand Down
98 changes: 98 additions & 0 deletions lib/classes/event/grouping_group_assigned.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?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/>.

/**
* Group assigned to grouping event.
*
* @package core
* @copyright 2016 Vadim Dvorovenko
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace core\event;
defined('MOODLE_INTERNAL') || die();

/**
* Group assigned to grouping event class.
*
* @package core
* @since Moodle 3.1
* @copyright 2016 Vadim Dvorovenko
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class grouping_group_assigned extends base {

/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' assigned the group with id '{$this->other['groupid']}'" .
" to the grouping with id '$this->objectid'.";
}

/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventgroupinggroupassigned', 'group');
}

/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/assign.php', array('id' => $this->objectid));
}

/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'c';
$this->data['edulevel'] = self::LEVEL_OTHER;
$this->data['objecttable'] = 'groupings';
}

/**
* This is used when restoring course logs where it is required that we
* map the objectid to its new value in the new course.
*
* @return string the name of the restore mapping the objectid links to
*/
public static function get_objectid_mapping() {
return array('db' => 'groupings', 'restore' => 'group');
}

/**
* This is used when restoring course logs where it is required that we
* map the information in 'other' to its new value in the new course.
*
* @return array an array of other values and their corresponding mapping
*/
public static function get_other_mapping() {
$othermapped = array();
$othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
return $othermapped;
}
}
98 changes: 98 additions & 0 deletions lib/classes/event/grouping_group_unassigned.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?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/>.

/**
* Group unassigned from grouping event.
*
* @package core
* @copyright 2016 Vadim Dvorovenko
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

namespace core\event;
defined('MOODLE_INTERNAL') || die();

/**
* Group unassigned from grouping event class.
*
* @package core
* @since Moodle 3.1
* @copyright 2016 Vadim Dvorovenko
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class grouping_group_unassigned extends base {

/**
* Returns description of what happened.
*
* @return string
*/
public function get_description() {
return "The user with id '$this->userid' unassigned the group with id '{$this->other['groupid']}'" .
" from the grouping with id '$this->objectid'.";
}

/**
* Return localised event name.
*
* @return string
*/
public static function get_name() {
return get_string('eventgroupinggroupunassigned', 'group');
}

/**
* Get URL related to the action.
*
* @return \moodle_url
*/
public function get_url() {
return new \moodle_url('/group/assign.php', array('id' => $this->objectid));
}

/**
* Init method.
*
* @return void
*/
protected function init() {
$this->data['crud'] = 'd';
$this->data['edulevel'] = self::LEVEL_OTHER;
$this->data['objecttable'] = 'groupings';
}

/**
* This is used when restoring course logs where it is required that we
* map the objectid to its new value in the new course.
*
* @return string the name of the restore mapping the objectid links to
*/
public static function get_objectid_mapping() {
return array('db' => 'groupings', 'restore' => 'group');
}

/**
* This is used when restoring course logs where it is required that we
* map the information in 'other' to its new value in the new course.
*
* @return array an array of other values and their corresponding mapping
*/
public static function get_other_mapping() {
$othermapped = array();
$othermapped['groupid'] = array('db' => 'groups', 'restore' => 'group');
return $othermapped;
}
}

0 comments on commit dd399f5

Please sign in to comment.