Group index page class. More...

Inheritance diagram for core_group\output\index_page:

Public Member Functions
	__construct ($courseid, $groups, $selectedgroupname, $selectedgroupmembers, $disableaddedit, $disabledelete, $undeletablegroups, $messagingsettingsvisible)
	index_page constructor.

	export_for_template (renderer_base $output)
	Export the data.

Public Attributes
int	$courseid
	$courseid The course ID.

bool	$disableaddedit
	Whether to disable the add members/edit group buttons.

bool	$disabledelete
	Whether to disable the delete group button.

array	$groups
	The array of groups to be rendered.

bool	$messagingsettingsvisible
	Whether to show/hide the messaging setting buttons.

array	$selectedgroupmembers
	The array of group members to be rendered, if a group is selected.

string	$selectedgroupname
	The name of the currently selected group.

array	$undeletablegroups
	Groups that can't be deleted by the user.

Detailed Description

Group index page class.

Constructor & Destructor Documentation

core_group\output\index_page::__construct	(	$courseid,
		$groups,
		$selectedgroupname,
		$selectedgroupmembers,
		$disableaddedit,
		$disabledelete,
		$undeletablegroups,
		$messagingsettingsvisible )

index_page constructor.

Parameters

int	$courseid	The course ID.
array	$groups	The array of groups to be rendered.
string	$selectedgroupname	The name of the currently selected group.
array	$selectedgroupmembers	The array of group members to be rendered, if a group is selected.
bool	$disableaddedit	Whether to disable the add members/edit group buttons.
bool	$disabledelete	Whether to disable the delete group button.
array	$undeletablegroups	Groups that can't be deleted by the user.
bool	$messagingsettingsvisible	If the messaging settings buttons should be visible.

core_group\output\index_page::export_for_template ( renderer_base $output )

Export the data.

Parameters

renderer_base $output

Return values

stdClass

The documentation for this class was generated from the following file: