 |
Moodle APIs
3.8
Moodle 3.8.6 (Build: 20201109)
|
|
Moodle APIs
3.8
Moodle 3.8.6 (Build: 20201109)
|
Functions | |
| _group_verify_activegroup ($courseid, $groupmode, $groupingid, array $allowedgroups) | |
| Internal method, sets up $SESSION->activegroup and verifies previous value. More... | |
| groups_allgroups_course_menu ($course, $urlroot, $update=false, $activegroup=0) | |
| Generates html to print menu selector for course level, listing all groups. More... | |
| groups_cache_groupdata ($courseid, cache $cache=null) | |
| Caches group data for a particular course to speed up subsequent requests. More... | |
| groups_get_activity_allowed_groups ($cm, $userid=0) | |
| groups_get_activity_group ($cm, $update=false, $allowedgroups=null) | |
| groups_get_activity_groupmode ($cm, $course=null) | |
| groups_get_activity_shared_group_members ($cm, $userid=null) | |
| Returns users who share group membership with the specified user in the given actiivty. More... | |
| groups_get_all_groupings ($courseid) | |
| groups_get_all_groups ($courseid, $userid=0, $groupingid=0, $fields='g.*', $withmembers=false) | |
| groups_get_course_data ($courseid, cache $cache=null) | |
| Gets group data for a course. More... | |
| groups_get_course_group ($course, $update=false, $allowedgroups=null) | |
| groups_get_course_groupmode ($course) | |
| groups_get_group ($groupid, $fields=' *', $strictness=IGNORE_MISSING) | |
| groups_get_group_by_idnumber ($courseid, $idnumber) | |
| groups_get_group_by_name ($courseid, $name) | |
| groups_get_group_name ($groupid) | |
| groups_get_grouping ($groupingid, $fields=' *', $strictness=IGNORE_MISSING) | |
| groups_get_grouping_by_idnumber ($courseid, $idnumber) | |
| groups_get_grouping_by_name ($courseid, $name) | |
| groups_get_grouping_members ($groupingid, $fields='u.*', $sort='lastname ASC') | |
| groups_get_grouping_name ($groupingid) | |
| groups_get_groups_members ($groupsids, $extrafields=null, $sort='lastname ASC') | |
| Returns the users in the specified groups. More... | |
| groups_get_members ($groupid, $fields='u.*', $sort='lastname ASC') | |
| groups_get_members_ids_sql ($groupid, context $context=null) | |
| Get sql and parameters that will return user ids for a group. More... | |
| groups_get_members_join ($groupid, $useridcolumn, context $context=null) | |
| Get sql join to return users in a group. More... | |
| groups_get_my_groups () | |
| groups_get_user_groups ($courseid, $userid=0) | |
| groups_group_exists ($groupid) | |
| groups_group_visible ($groupid, $course, $cm=null, $userid=null) | |
| Determine if a given group is visible to user or not in a given context. More... | |
| groups_has_membership ($cm, $userid=null) | |
| groups_is_member ($groupid, $userid=null) | |
| groups_list_to_menu ($groups) | |
| Turn an array of groups into an array of menu options. More... | |
| groups_print_activity_menu ($cm, $urlroot, $return=false, $hideallparticipants=false) | |
| groups_print_course_menu ($course, $urlroot, $return=false) | |
| groups_sort_menu_options ($allowedgroups, $usergroups) | |
| Takes user's allowed groups and own groups and formats for use in group selector menu If user has allowed groups + own groups will add to an optgroup Own groups are removed from allowed groups. More... | |
| groups_user_groups_visible ($course, $userid, $cm=null) | |
| Determine if the current user can see at least one of the groups of the specified user. More... | |
Variables | |
| const | NOGROUPS 0 |
| Groups not used in course or activity. | |
| const | SEPARATEGROUPS 1 |
| Groups used, users do not see other groups. | |
| const | USERSWITHOUTGROUP -1 |
| This is for filtering users without any group. | |
| const | VISIBLEGROUPS 2 |
| Groups used, students see other groups. | |
1.8.20