| [ Index ] |
PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008] |
[Source view] [Print] [Project Stats]
Groups not used in course or activity
| File Size: | 718 lines (26 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| groups_group_exists($groupid) X-Ref |
| Determines if a group with a given groupid exists. param: int $groupid The groupid to check for return: boolean True if the group exists, false otherwise or if an error |
| groups_get_group_name($groupid) X-Ref |
| Gets the name of a group with a specified id param: int $groupid The id of the group return: string The name of the group |
| groups_get_grouping_name($groupingid) X-Ref |
| Gets the name of a grouping with a specified id param: int $groupingid The id of the grouping return: string The name of the grouping |
| groups_get_group_by_name($courseid, $name) X-Ref |
| Returns the groupid of a group with the name specified for the course. Group names should be unique in course param: int $courseid The id of the course param: string $name name of group (without magic quotes) return: int $groupid |
| groups_get_grouping_by_name($courseid, $name) X-Ref |
| Returns the groupingid of a grouping with the name specified for the course. Grouping names should be unique in course param: int $courseid The id of the course param: string $name name of group (without magic quotes) return: int $groupid |
| groups_get_group($groupid) X-Ref |
| Get the group object param: groupid ID of the group. return: group object |
| groups_get_grouping($groupingid) X-Ref |
| Get the grouping object param: groupingid ID of the group. return: group object |
| groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.*') X-Ref |
| Gets array of all groups in a specified course. param: int $courseid The id of the course. param: mixed $userid optional user id or array of ids, returns only groups of the user. param: int $groupingid optional returns only groups in the specified grouping. return: array | false Returns an array of the group objects or false if no records |
| groups_get_user_groups($courseid, $userid=0) X-Ref |
| Returns info about user's groups in course. param: int $courseid param: int $userid $USER if not specified return: array[groupingid][groupid] including grouping id 0 which means all groups |
| groups_get_all_groupings($courseid) X-Ref |
| Gets array of all groupings in a specified course. param: int $courseid return only groupings in this with this courseid return: array | false Returns an array of the grouping objects or false if no records |
| groups_is_member($groupid, $userid=null) X-Ref |
| Determines if the user is a member of the given group. param: int $groupid The group to check for membership. param: int $userid The user to check against the group. return: boolean True if the user is a member, false otherwise. |
| groups_has_membership($cm, $userid=null) X-Ref |
| Determines if current or specified is member of any active group in activity param: object $cm coruse module object param: int $userid id of user, null menas $USER->id return: booelan true if user member of at least one group used in activity |
| groups_get_members($groupid, $fields='u.*', $sort='lastname ASC') X-Ref |
| Returns the users in the specified group. param: int $groupid The groupid to get the users for param: int $fields The fields to return param: int $sort optional sorting of returned users return: array | false Returns an array of the users for the specified |
| groups_get_grouping_members($groupingid, $fields='u.*', $sort='lastname ASC') X-Ref |
| Returns the users in the specified grouping. param: int $groupingid The groupingid to get the users for param: int $fields The fields to return param: int $sort optional sorting of returned users return: array | false Returns an array of the users for the specified |
| groups_get_course_groupmode($course) X-Ref |
| Returns effective groupmode used in course return: integer group mode |
| groups_get_activity_groupmode($cm, $course=null) X-Ref |
| Returns effective groupmode used in activity, course setting overrides activity setting if groupmodeforce enabled. param: $cm the course module object. Only the ->course and ->groupmode need to be set. param: $course object optional course object to improve perf return: integer group mode |
| groups_print_course_menu($course, $urlroot, $return=false) X-Ref |
| Print group menu selector for course level. param: object $course course object param: string $urlroot return address param: boolean $return return as string instead of printing return: mixed void or string depending on $return param |
| groups_print_activity_menu($cm, $urlroot, $return=false, $hideallparticipants=false) X-Ref |
| Print group menu selector for activity. param: object $cm course module object param: string $urlroot return address that users get to if they choose an option; param: boolean $return return as string instead of printing param: boolean $hideallparticipants If true, this prevents the 'All participants' return: mixed void or string depending on $return param |
| groups_get_course_group($course, $update=false) X-Ref |
| Returns group active in course, changes the group by default if 'group' page param present param: object $course course bject param: boolean $update change active group if group param submitted return: mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode) |
| groups_get_activity_group($cm, $update=false) X-Ref |
| Returns group active in activity, changes the group by default if 'group' page param present param: object $cm course module object param: boolean $update change active group if group param submitted return: mixed false if groups not used, int if groups used, 0 means all groups (access must be verified in SEPARATE mode) |
| groups_get_activity_allowed_groups($cm,$userid=0) X-Ref |
| Gets a list of groups that the user is allowed to access within the specified activity. param: object $cm Course-module param: int $userid User ID (defaults to current user) return: array An array of group objects, or false if none |
| groups_course_module_visible($cm, $userid=null) X-Ref |
| Determine if a course module is currently visible to a user param: int $cm The course module param: int $userid The user to check against the group. return: boolean True if the user can view the course module, false otherwise. |
| Generated: Wed Jan 14 11:33:29 2009 | Cross-referenced by PHPXref 0.7 |