Groups API - Revision history

Devdocsbot: Protected "Groups API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-17T11:07:20Z

Protected "Groups API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 11:07, 17 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-17T11:04:59Z

Update migration status and path

← Older revision		Revision as of 11:04, 17 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/group/}}
	==Overview==		==Overview==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:29:39Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:29, 14 July 2021
				
Line 76:
Line 76:
This is using an example from the module forums. This is using an example from the module forums.



<code php> <syntaxhighlight lang="php">
// Get the course module id from a post or get request. // Get the course module id from a post or get request.
$id = required_param('id', PARAM_INT);   $id = required_param('id', PARAM_INT);  
Line 95:
Line 95:
For this example we are going to check to see if groups are active and whether the user has access to the discussion. For this example we are going to check to see if groups are active and whether the user has access to the discussion.



<code php> <syntaxhighlight lang="php">
// Get the course module and discussion id from a post or get request. // Get the course module and discussion id from a post or get request.
$id           = required_param('id', PARAM_INT); $id           = required_param('id', PARAM_INT);
Line 124:
Line 124:
It will also check to see what groups the user has access to and display the group options accordingly.   It will also check to see what groups the user has access to and display the group options accordingly.  



<code php> <syntaxhighlight lang="php">
// Get the course module id from a post or get request // Get the course module id from a post or get request
$id = required_param('id', PARAM_INT);   $id = required_param('id', PARAM_INT);  
Line 183:
Line 183:



===Examples=== ===Examples===
<code php> <syntaxhighlight lang="php">
require_once($CFG->dirroot.'/group/lib.php'); require_once($CFG->dirroot.'/group/lib.php');

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:02:46Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:02, 14 July 2021
Line 89:		Line 89:

	// Do as you please with your newly obtained group information.		// Do as you please with your newly obtained group information.
	</~~code~~>		</syntaxhighlight>

	===How to make sure that the current user can see a given item in your module ===		===How to make sure that the current user can see a given item in your module ===
Line 117:		Line 117:

	// Continue on with group specific discussion		// Continue on with group specific discussion
	</~~code~~>		</syntaxhighlight>

	===How to display a group menu===		===How to display a group menu===
Line 138:		Line 138:
	// or has access to all groups).		// or has access to all groups).
	groups_print_activity_menu($cm, $url);		groups_print_activity_menu($cm, $url);
	</~~code~~>		</syntaxhighlight>

	=== New group/lib.php ===		=== New group/lib.php ===
Line 194:		Line 194:

	$newgroupid = groups_create_group($data);		$newgroupid = groups_create_group($data);
	</~~code~~>		</syntaxhighlight>

	==Further reading==		==Further reading==

Nadavkav: /* File locations */

2018-12-24T14:37:45Z

File locations

← Older revision		Revision as of 14:37, 24 December 2018
Line 30:		Line 30:
	==File locations==		==File locations==

	The Groups API is all in lib/grouplib.php and is automatically included for you during the page setup.		The Groups API is all in [https://github.com/moodle/moodle/blob/master/lib/grouplib.php lib/grouplib.php] and is automatically included for you during the page setup.

	==Functions==		==Functions==

Nadavkav: /* New group/lib.php */

2018-12-24T14:36:47Z

New group/lib.php

← Older revision		Revision as of 14:36, 24 December 2018
Line 141:		Line 141:

	=== New group/lib.php ===		=== New group/lib.php ===

			https://github.com/moodle/moodle/blob/master/group/lib.php

	* groups_add_member($grouporid, $userorid)		* groups_add_member($grouporid, $userorid)
	* groups_remove_member($grouporid, $userorid)		* groups_remove_member($grouporid, $userorid)

Nadavkav: /* Examples */

2018-12-24T14:34:47Z

Examples

← Older revision		Revision as of 14:34, 24 December 2018
Line 184:		Line 184:

	$data = new stdClass();		$data = new stdClass();
	$data->courseid = ~~idcourse~~;		$data->courseid = $COURSE->id;
	$data->idnumber = someidnumber;		$data->idnumber = 'someidnumber';
	$data->name = 'group name';		$data->name = 'group name';
	$data->description = 'group description';		$data->description = 'group description';

Nadavkav: /* Examples */

2018-12-24T14:33:50Z

Examples

← Older revision		Revision as of 14:33, 24 December 2018
Line 180:		Line 180:

	===Examples===		===Examples===
			<code php>
	require_once($CFG->dirroot.'/group/lib.php');		require_once($CFG->dirroot.'/group/lib.php');

Line 190:		Line 191:

	$newgroupid = groups_create_group($data);		$newgroupid = groups_create_group($data);
			</code>

	==Further reading==		==Further reading==

Nadavkav: /* Further reading */

2018-12-24T14:26:07Z

Jesmarquez: /* Functions */

2016-05-24T14:40:57Z

Functions

← Older revision		Revision as of 14:40, 24 May 2016
Line 38:		Line 38:
	**groups_group_exists($groupid)		**groups_group_exists($groupid)
	**groups_get_group_name($groupid)		**groups_get_group_name($groupid)
	**groups_get_group_by_name($courseid, $name)		**groups_get_group_by_name($courseid, $name)
			**groups_get_group_by_idnumber($courseid, $idnumber)
	*groups_get_group($groupid, $fields='', $strictness=IGNORE_MISSING)		*groups_get_group($groupid, $fields='', $strictness=IGNORE_MISSING)
	*groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.')		*groups_get_all_groups($courseid, $userid=0, $groupingid=0, $fields='g.')

← Older revision		Revision as of 13:29, 14 July 2021
Line 76:		Line 76:
	This is using an example from the module forums.		This is using an example from the module forums.

	<~~code~~ php>		<syntaxhighlight lang="php">
	// Get the course module id from a post or get request.		// Get the course module id from a post or get request.
	$id = required_param('id', PARAM_INT);		$id = required_param('id', PARAM_INT);
Line 95:		Line 95:
	For this example we are going to check to see if groups are active and whether the user has access to the discussion.		For this example we are going to check to see if groups are active and whether the user has access to the discussion.

	<~~code~~ php>		<syntaxhighlight lang="php">
	// Get the course module and discussion id from a post or get request.		// Get the course module and discussion id from a post or get request.
	$id = required_param('id', PARAM_INT);		$id = required_param('id', PARAM_INT);
Line 124:		Line 124:
	It will also check to see what groups the user has access to and display the group options accordingly.		It will also check to see what groups the user has access to and display the group options accordingly.

	<~~code~~ php>		<syntaxhighlight lang="php">
	// Get the course module id from a post or get request		// Get the course module id from a post or get request
	$id = required_param('id', PARAM_INT);		$id = required_param('id', PARAM_INT);
Line 183:		Line 183:

	===Examples===		===Examples===
	<~~code~~ php>		<syntaxhighlight lang="php">
	require_once($CFG->dirroot.'/group/lib.php');		require_once($CFG->dirroot.'/group/lib.php');

@@ Line 139: / Line 139: @@
 groups_print_activity_menu($cm, $url);
 </code>
 ==Further reading==

Groups API - Revision history

Devdocsbot: Protected "Groups API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Nadavkav: /* File locations */

Nadavkav: /* New group/lib.php */

Nadavkav: /* Examples */

Nadavkav: /* Examples */

Nadavkav: /* Further reading */

Jesmarquez: /* Functions */

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""