Merge branch 'MDL-80633-main' of https://github.com/laurentdavid/moodle
[moodle.git] / group / upgrade.txt
blobf176eb310c811cf8c6b093cc2c8ab3b556fb6d35
1 This files describes API changes in /group/*,
2 information provided here is intended especially for developers.
4 === 4.3 ===
5 * The following external methods now return group names correctly formatted:
6   - `core_group_get_groups`
7   - `core_group_get_course_groups`
8   - `core_group_get_course_user_groups`
9   - `core_group_get_activity_allowed_groups`
10 * Groups now have access to create GeoPattern default images based upon their ID with their associated course context.
11   This can be done by calling the following:
12        moodle_url::make_pluginfile_url(
13            $coursecontext->id,
14            'group',
15            'generated',
16            $group->id,
17            '/',
18            'group.svg'
19        );
20 * Added group/grouping custom fields.
21 * groups_get_members_join() now includes visibility checks for group memberships.
22 * \core_group\visibility::sql_member_visibility_where() no longer prefixes the returned WHERE statement with AND, to
23   give the calling code greater flexibility about how to use it.
25 === 4.2 ===
26 * `\core_group\visibility` class added to support new `visibility` field in group records. This holds the visibility constants
27   and helper functions for applying visibility restrictions when querying groups or group members in the database.
28 * Changes to the group form to support visibility features:
29   - New `visibility` field.
30   - New `participation` field.
31   - `participation` and `enablemessaging` fields are disabled (default: false) when `visibility` is set
32     to `visibility::OWN` or `visibility::NONE`.
33 * The following externallib functions now accept `visibility` and `participation` as optional parameters:
34   - create_groups()
35   - update_groups()
36 * The following externallib functions now also return `visibility` and `participation` fields in their responses:
37   - create_groups()
38   - get_groups()
39   - get_course_groups()
41 === 3.11 ===
43 * The groups do not support 'hidepicture' any more, and so the column 'hidepicture'
44   from the table {groups} has be dropped.