Development:Groups documentation for module developers - Revision history

TimHunt at 15:40, 12 December 2007

2007-12-12T15:40:13Z

← Older revision		Revision as of 15:40, 12 December 2007
Line 1:		Line 1:
			'''IMPORTANT:''' This page is now obsolete! see [[Development:Groups]] instead.

	== Groups in Moodle for developers==		== Groups in Moodle for developers==

	~~'''IMPORTANT:'''~~ This documentation does not refer to current versions of Moodle		This documentation does not refer to current versions of Moodle
	and is here at the moment purely in order to obtain comments. Descriptions of		and is here at the moment purely in order to obtain comments. Descriptions of
	how groups work refer to how they hopefully work not how they will work now! This document is also written in the present tense even though it doesn't refer to the current version of Moodle. This is so I don't have to go through and change it all in a month or two's time.		how groups work refer to how they hopefully work not how they will work now! This document is also written in the present tense even though it doesn't refer to the current version of Moodle. This is so I don't have to go through and change it all in a month or two's time.

Tsala: cat edit

2007-06-18T09:11:40Z

cat edit

← Older revision		Revision as of 09:11, 18 June 2007
Line 221:		Line 221:
	groupid argument that defaults to false.		groupid argument that defaults to false.

	[[Category:Developer]]		[[Category:Developer\|Groups documentation]]
	[[Category:Groups]]		[[Category:Groups]]

Mac2kw: /* From a student's point of view */

2007-03-09T19:57:23Z

From a student's point of view

← Older revision		Revision as of 19:57, 9 March 2007
Line 41:		Line 41:
	contribution after the activity has started and so is different for each group.		contribution after the activity has started and so is different for each group.

	In general if your module needs to support groups in this way you will find that		In general if your module needs to support groups in this way, you will find that
	the database table(s) where you store the students' contributions will probably		the database table(s) where you store the students' contributions will probably
	need an extra 'groupid' column, for instance the forum table has a groupid		need an extra 'groupid' column, for instance the forum table has a groupid

Mac2kw: /* From a student's point of view */

2007-03-09T19:56:37Z

From a student's point of view

← Older revision		Revision as of 19:56, 9 March 2007
Line 41:		Line 41:
	contribution after the activity has started and so is different for each group.		contribution after the activity has started and so is different for each group.

	In general if ~~you~~ module needs to support groups in this way you will find that		In general if your module needs to support groups in this way you will find that
	the database table(s) where you store the students' contributions will probably		the database table(s) where you store the students' contributions will probably
	need an extra 'groupid' column, for instance the forum table has a groupid		need an extra 'groupid' column, for instance the forum table has a groupid
	column.		column.

	==== From a teacher's point of view ====		==== From a teacher's point of view ====

Dougiamas: Groups documentation for module developers moved to Development:Groups documentation for module developers

2006-12-12T09:09:01Z

Groups documentation for module developers moved to Development:Groups documentation for module developers

← Older revision	Revision as of 09:09, 12 December 2006
(No difference)

Jvvw: /* Support for legacy code */

2006-08-23T20:46:52Z

Support for legacy code

← Older revision		Revision as of 20:46, 23 August 2006
Line 124:		Line 124:

	get_groups		get_groups

	user_group		user_group

	ismember		ismember

	get_group_users		get_group_users

	get_group_students		get_group_students

	get_group_teachers		get_group_teachers

	add_user_to_group		add_user_to_group

	mygroupid		mygroupid

	groupmode		groupmode

	set_current_group		set_current_group

	get_current_group		get_current_group

	get_and_set_current_group		get_and_set_current_group

	setup_and_print_groups		setup_and_print_groups

Line 151:		Line 163:
	The groupid argument in the function search_users from datalib.php will still		The groupid argument in the function search_users from datalib.php will still
	work, but will only give members of a group, not those with a specific		work, but will only give members of a group, not those with a specific
	permission.		permission.

	=== Blocks and other special cases ===		=== Blocks and other special cases ===

Jvvw at 08:09, 22 August 2006

2006-08-22T08:09:50Z

@@ Line 208: / Line 208: @@
 too much extra code this way anyhow - you can always write functions with a
 groupid argument that defaults to false.
 [[Category:Developer]]
 [[Category:Groups]]

Jvvw at 08:08, 22 August 2006

2006-08-22T08:08:40Z

← Older revision		Revision as of 08:08, 22 August 2006
Line 8:		Line 8:

	There is a separate document on [[How groups work in Moodle]] which is worth reading for background especially if you are new to groups in Moodle, although most of the details aren't relevant for module developers. From a module developer's point of view, the differences aren't actually too big. The main changes is that there may be a different set of groups being used for each instance of you module in the course and that separate/visible groups have been replaced by a better system of permissions. The other big changes are all being handled by code elsewhere. There have also been some changes to the database structure for groups (for instance there is now a separate course_group table rather than courseid being a column in the groups table which may affect your code if it has been accessing the database directly for some reason).		There is a separate document on [[How groups work in Moodle]] which is worth reading for background especially if you are new to groups in Moodle, although most of the details aren't relevant for module developers. From a module developer's point of view, the differences aren't actually too big. The main changes is that there may be a different set of groups being used for each instance of you module in the course and that separate/visible groups have been replaced by a better system of permissions. The other big changes are all being handled by code elsewhere. There have also been some changes to the database structure for groups (for instance there is now a separate course_group table rather than courseid being a column in the groups table which may affect your code if it has been accessing the database directly for some reason).

			As well as modules, there are also some blocks and global features such as blogs
			and the calendar that use groups in certain ways. We'll come to those later.

			It is obviously good if modules support groups in the ways that users expect!
			This document is here to try and help you do that - if anything isn't clear, you
			have questions or can think of improvements to how groups work in Moodle, please
			post on the Groups forum on moodle.org.

	=== How should modules support groups? ===		=== How should modules support groups? ===

Jvvw at 07:59, 22 August 2006

2006-08-22T07:59:51Z

@@ Line 7: / Line 7: @@
 === How groups work in Moodle ===
-It is possible to have groups of users in Moodle. A person with the right
+There is a separate document on [[How groups work in Moodle]] which is worth reading for background especially if you are new to groups in Moodle, although most of the details aren't relevant for module developers. From a module developer's point of view, the differences aren't actually too big.  The main changes is that there may be a different set of groups being used for each instance of you module in the course and that separate/visible groups have been replaced by a better system of permissions. The other big changes are all being handled by code elsewhere. There have also been some changes to the database structure for groups (for instance there is now a separate course_group table rather than courseid being a column in the groups table which may affect your code if it has been accessing the database directly for some reason).
 === How should modules support groups? ===

Jvvw: /* How groups work in Moodle */

2006-08-22T07:50:15Z

How groups work in Moodle

← Older revision		Revision as of 07:50, 22 August 2006
Line 6:		Line 6:

	=== How groups work in Moodle ===		=== How groups work in Moodle ===

	~~[[How groups work in Moodle]]~~

	It is possible to have groups of users in Moodle. A person with the right		It is possible to have groups of users in Moodle. A person with the right