mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-19 07:25:30 +02:00
Code Issues Projects Releases Wiki Activity

MDL-81850 availability_group: correctly retrieve groups for given user.

Browse Source
This commit is contained in:
Paul Holden 2024-05-22 09:18:41 +01:00
parent bcae2164ac
commit ad693b830a
No known key found for this signature in database
GPG Key ID: A81A96D6045F6164
4 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
availability/classes/info.php
View File

@ -49,8 +49,8 @@ abstract class info {
/** @var tree Availability configuration, decoded from JSON; null if unset */
protected $availabilitytree;
/** @var array The groups the current user belongs to. */
protected $groups;
/** @var array The groups each user belongs to. */
protected $groups = [];
/** @var array|null Array of information about current restore if any */
protected static $restoreinfo = null;
@ -61,14 +61,12 @@ abstract class info {
* @param \stdClass $course Course object
* @param int $visible Value of visible flag (eye icon)
* @param string $availability Availability definition (JSON format) or null
* @throws \coding_exception If data is not valid JSON format
*/
public function __construct($course, $visible, $availability) {
// Set basic values.
$this->course = $course;
$this->visible = (bool)$visible;
$this->availability = $availability;
$this->groups = null;
}
/**
@ -806,22 +804,26 @@ abstract class info {
}
/**
* Returns groups that the current user belongs to on the course. Note: If not already
* Returns groups that the given user belongs to on the course. Note: If not already
* available, this may make a database query.
*
* This will include groups the user is not allowed to see themselves, so check visibility
* before displaying groups to the user.
*
* @param int $groupingid Grouping ID or 0 (default) for all groups
* @param int $userid User ID or 0 (default) for current user
* @return int[] Array of int (group id) => int (same group id again); empty array if none
*/
public function get_groups(int $groupingid = 0): array {
public function get_groups(int $groupingid = 0, int $userid = 0): array {
global $USER;
if (is_null($this->groups)) {
$allgroups = groups_get_user_groups($this->course->id, $USER->id, true);
$this->groups = $allgroups;
if (empty($userid)) {
$userid = $USER->id;
}
if (!array_key_exists($userid, $this->groups)) {
$allgroups = groups_get_user_groups($this->course->id, $userid, true);
$this->groups[$userid] = $allgroups;
} else {
$allgroups = $this->groups;
$allgroups = $this->groups[$userid];
}
if (!isset($allgroups[$groupingid])) {
return [];

2
availability/condition/group/classes/condition.php
View File

@ -71,7 +71,7 @@ class condition extends \core_availability\condition {
$allow = true;
if (!has_capability('moodle/site:accessallgroups', $context, $userid)) {
// Get all groups the user belongs to.
$groups = $info->get_groups();
$groups = $info->get_groups(0, $userid);
if ($this->groupid) {
$allow = in_array($this->groupid, $groups);
} else {

11
availability/condition/group/tests/condition_test.php
View File

@ -47,9 +47,9 @@ class condition_test extends \advanced_testcase {
// Make a test course and user.
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$user = $generator->create_user();
$generator->enrol_user($user->id, $course->id);
$this->setUser($user);
$user = $generator->create_and_enrol($course);
$usertwo = $generator->create_and_enrol($course);
$info = new \core_availability\mock_info($course, $user->id);
// Make 2 test groups, one in a grouping and one not.
@ -76,6 +76,8 @@ class condition_test extends \advanced_testcase {
// Recheck.
$this->assertTrue($cond->is_available(false, $info, true, $user->id));
$this->assertFalse($cond->is_available(true, $info, true, $user->id));
$this->assertFalse($cond->is_available(false, $info, true, $usertwo->id));
$this->assertTrue($cond->is_available(true, $info, true, $usertwo->id));
$information = $cond->get_description(false, true, $info);
$information = \core_availability\info::format_info($information, $course);
$this->assertMatchesRegularExpression('~do not belong to.*G1!~', $information);
@ -83,11 +85,14 @@ class condition_test extends \advanced_testcase {
// Check group 2 works also.
$cond = new condition((object)array('id' => (int)$group2->id));
$this->assertTrue($cond->is_available(false, $info, true, $user->id));
$this->assertFalse($cond->is_available(false, $info, true, $usertwo->id));
// What about an 'any group' condition?
$cond = new condition((object)array());
$this->assertTrue($cond->is_available(false, $info, true, $user->id));
$this->assertFalse($cond->is_available(true, $info, true, $user->id));
$this->assertFalse($cond->is_available(false, $info, true, $usertwo->id));
$this->assertTrue($cond->is_available(true, $info, true, $usertwo->id));
$information = $cond->get_description(false, true, $info);
$information = \core_availability\info::format_info($information, $course);
$this->assertMatchesRegularExpression('~do not belong to any~', $information);

4
availability/upgrade.txt
View File

@ -2,6 +2,10 @@ This files describes API changes in /availability/*.
The information here is intended only for developers.
=== 4.4.1 ===
* The base class `info::get_groups` method has a `$userid` parameter to specify for which user you want to retrieve course groups (defaults
to current user)
=== 4.3 ===
* The `availability_info templatable` no longer exports 'showmore' information, and any component rendering avaialable_info
should handle showmore/showless behaviour by itself.