mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-18 22:08:20 +01:00
Code Issues Projects Releases Wiki Activity

MDL-79174 groups: Add includehidden parameter

Browse Source 
This allows groups_get_user_groups to return groups with
GROUP_VISIBILITY_NONE that the specified user belongs to. The parameter
is false by default, and should be use with care as membership of these
groups should not be revealed to the user.
This commit is contained in:
Mark Johnson 2024-02-21 14:12:05 +00:00
parent d3ad77e476
commit ce706292bf
No known key found for this signature in database
GPG Key ID: EB30E1468CFAE242
3 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/grouplib.php
View File

@ -457,9 +457,12 @@ function groups_get_my_groups() {
* @category group
* @param int $courseid
* @param int $userid $USER if not specified
* @param bool $includehidden Include groups with GROUP_VISIBILITY_NONE that the user is a member of, but is not allowed to see
* themselves. Use this parameter with care - it is the responsibility of the calling code to ensure these groups are not exposed
* to the user, as this could have privacy implications.
* @return array Array[groupingid][groupid] including grouping id 0 which means all groups
*/
function groups_get_user_groups($courseid, $userid=0) {
function groups_get_user_groups(int $courseid, int $userid = 0, bool $includehidden = false): array {
global $USER, $DB;
if (empty($courseid)) {
@ -471,7 +474,7 @@ function groups_get_user_groups($courseid, $userid=0) {
}
$usergroups = false;
$viewhidden = has_capability('moodle/course:viewhiddengroups', context_course::instance($courseid));
$viewhidden = $includehidden || has_capability('moodle/course:viewhiddengroups', context_course::instance($courseid));
$viewall = \core_group\visibility::can_view_all_groups($courseid);
$cache = cache::make('core', 'user_group_groupings');
@ -483,7 +486,7 @@ function groups_get_user_groups($courseid, $userid=0) {
if ($usergroups === false) {
$sql = "SELECT g.id, g.courseid, gg.groupingid
$sql = "SELECT g.id, g.courseid, gg.groupingid, g.visibility
FROM {groups} g
JOIN {groups_members} gm ON gm.groupid = g.id
LEFT JOIN {groupings_groups} gg ON gg.groupid = g.id

9
lib/tests/grouplib_test.php
View File

@ -2109,6 +2109,12 @@ class grouplib_test extends \advanced_testcase {
// Own groups - should see all groups except group with visibility::NONE.
$usergroups1 = groups_get_user_groups($course->id, $users[1]->id);
$this->assertEquals([$groups['all']->id, $groups['members']->id, $groups['own']->id], $usergroups1[0]);
// Own groups including hidden - should see all groups.
$usergroups1hidden = groups_get_user_groups($course->id, $users[1]->id, true);
$this->assertEquals(
[$groups['all']->id, $groups['members']->id, $groups['own']->id, $groups['none']->id],
$usergroups1hidden[0]
);
// Fellow member of a group with visiblity::MEMBERS. Should see that group.
$usergroups2 = groups_get_user_groups($course->id, $users[2]->id);
$this->assertEquals([$groups['members']->id], $usergroups2[0]);
@ -2118,6 +2124,9 @@ class grouplib_test extends \advanced_testcase {
// Fellow member of a group with visiblity::NONE. Should not see that group.
$usergroups4 = groups_get_user_groups($course->id, $users[4]->id);
$this->assertEmpty($usergroups4[0]);
// Fellow member of a group with visiblity::NONE including hidden. Should see that group.
$usergroups4hidden = groups_get_user_groups($course->id, $users[4]->id, true);
$this->assertEquals([$groups['none']->id], $usergroups4hidden[0]);
// Run as a user with viewhiddengroups. Should see all group memberships for each member.
$this->setUser($users[5]);

3
lib/upgrade.txt
View File

@ -55,6 +55,9 @@ information provided here is intended especially for developers.
* The nocache option for format_text has been removed. It was deprecated in Moodle 2.3.
* The set_heading() method has a new parameter, $clean, to define whether the heading should be cleaned or not when no formatting
is applied.
* groups_get_user_groups() in grouplib has a new $includehidden paramater, which will return groups for user even if they have
GROUP_VISIBILITY_NONE. This is false by default, and should be used with care. The calling code must ensure that these groups
are not exposed to the user as this may be a privacy issue.
=== 4.3 ===