Go to the source code of this file.
Namespaces | |
| namespace | CLGRP |
Functions | |
| empty_group ($groupIdList= 'ALL', $course_id=null) | |
| delete_groups ($groupIdList= 'ALL') | |
| deleteAllGroups () | |
| fill_in_groups ($nbGroupPerUser, $course_id) | |
| group_count_students_in_course ($course_id) | |
| group_count_students_in_groups ($course_id=null) | |
| group_count_students_in_group ($group_id, $course_id=null) | |
| group_count_group_of_a_user ($user_id, $course_id=null) | |
| create_group ($prefixGroupName, $maxMember) | |
| get_course_tutor_list ($currentCourseId) | |
| get_group_tool_list ($course_id=NULL, $active=true) | |
| get_user_group_list ($userId, $course=null) | |
| get_tutor_group_list ($uid) | |
| get_group_user_list ($gid, $courseId=NULL) | |
| get_group_list_user_id_list ($gidList, $courseId=NULL) | |
| get_current_course_group_properties () | |
| is_tool_available_in_current_course_groups ($moduleLabel) | |
| create_group | ( | $ | prefixGroupName, | |
| $ | maxMember | |||
| ) |
Create a new group
| string | $groupName - name of the group | |
| integer | $maxMember - max user allowed for this group |
Create a directory allowing group student to upload documents
Definition at line 465 of file group.lib.inc.php.
| delete_groups | ( | $ | groupIdList = 'ALL' |
) |
function delete_groups($groupIdList = 'ALL') deletes groups and their datas.
| mixed | $groupIdList - group(s) to delete. It can be a single id (int) or a list of id (array). If no id is given all the course group are deleted |
| claro_failure |
Check the data and notify eventmanager of the deletion
Archive and delete the group files
Definition at line 85 of file group.lib.inc.php.
| deleteAllGroups | ( | ) |
Alias of delete_groups() called without parameters
Definition at line 224 of file group.lib.inc.php.
| empty_group | ( | $ | groupIdList = 'ALL', |
|
| $ | course_id = null | |||
| ) |
Remove all user of a group
| mixed | $groupIdList indicates wich group(s) will be emptied * integer:group_id | array: array of group_id | string 'ALL' * default : ALL | |
| string | $course_id course context where the group(s) can be founded * default : null (get id from init) |
| claro_failure | errors |
Definition at line 37 of file group.lib.inc.php.
| fill_in_groups | ( | $ | nbGroupPerUser, | |
| $ | course_id | |||
| ) |
Fill in the groups with still unenrolled students. The algorithm takes care to fill first the freest groups with the less enrolled users
| integer | $nbGroupPerUser | |
| string | $course_id course context where the group(s) can be founded |
Retrieve the present state of the users repartion in groups
Compute the most approriate group fill in
Definition at line 243 of file group.lib.inc.php.
| get_course_tutor_list | ( | $ | currentCourseId | ) |
Return the list of tutor in the current course.
| string | $currentCourseId |
Definition at line 543 of file group.lib.inc.php.
| get_current_course_group_properties | ( | ) |
TODO : merge with claro_main.lib.php::claro_get_main_group_properties TODO : merge both with kernel/course.lib.phpClaro_Course
Definition at line 752 of file group.lib.inc.php.
| get_group_list_user_id_list | ( | $ | gidList, | |
| $ | courseId = NULL | |||
| ) |
return list of user of the group id list. All group must be in the same course
| int | $gidList list of groupe identification |
Definition at line 723 of file group.lib.inc.php.
| get_group_tool_list | ( | $ | course_id = NULL, |
|
| $ | active = true | |||
| ) |
This dirty function is a blackbox to provide normalised output of tool list for a group like get_course_tool_list($course_id=NULL) in course_home.
It's dirty because data structure is dirty. Tool_list (with clarolabel and tid come from tool tables and group properties and localinit)
| $course_id | ||
| boolean | $active, if set to true, only activated tools of the platform must be returned |
Definition at line 571 of file group.lib.inc.php.
| get_group_user_list | ( | $ | gid, | |
| $ | courseId = NULL | |||
| ) |
return list of user of the group id
| int | $gid groupe identification |
Definition at line 703 of file group.lib.inc.php.
| get_tutor_group_list | ( | $ | uid | ) |
return list of groups id where a given user (userId) is tutor
| integer | $uid uid to find groups where he's tutor |
Definition at line 682 of file group.lib.inc.php.
| get_user_group_list | ( | $ | userId, | |
| $ | course = null | |||
| ) |
Return list of groupe subscribed by a given user in a given/current course
| integer | $user_id | |
| course_syscode | $course |
Definition at line 650 of file group.lib.inc.php.
| group_count_group_of_a_user | ( | $ | user_id, | |
| $ | course_id = null | |||
| ) |
Count groups where a user is ennrolled in a given course
| integer | $user_id | |
| integer | (optional) course_id |
Definition at line 445 of file group.lib.inc.php.
| group_count_students_in_course | ( | $ | course_id | ) |
Count student in course.
| string | course_id |
| claro_failure |
Definition at line 391 of file group.lib.inc.php.
| group_count_students_in_group | ( | $ | group_id, | |
| $ | course_id = null | |||
| ) |
Count users in a given group.
| interger | (optional) group_id | |
| interger | (optional) course_id |
Definition at line 427 of file group.lib.inc.php.
| group_count_students_in_groups | ( | $ | course_id = null |
) |
Count users in all groups.
| interger | (optional) course_id |
Definition at line 410 of file group.lib.inc.php.
| is_tool_available_in_current_course_groups | ( | $ | moduleLabel | ) |
TODO : use is_tool_activated_in_groups() to check if the tool is globaly available
Definition at line 809 of file group.lib.inc.php.
1.6.3