Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_group\output\index_page Class Reference

Group index page class. More...

Inheritance diagram for core_group\output\index_page:
renderable templatable

Public Member Functions

 __construct ($courseid, $groups, $selectedgroupname, $selectedgroupmembers, $disableaddedit, $disabledelete, $undeletablegroups)
 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.
 
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.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

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

index_page constructor.

Parameters
int$courseidThe course ID.
array$groupsThe array of groups to be rendered.
string$selectedgroupnameThe name of the currently selected group.
array$selectedgroupmembersThe array of group members to be rendered, if a group is selected.
bool$disableaddeditWhether to disable the add members/edit group buttons.
bool$disabledeleteWhether to disable the delete group button.
array$undeletablegroupsGroups that can't be deleted by the user.

Member Function Documentation

◆ export_for_template()

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

Export the data.

Parameters
renderer_base$output
Return values
stdClass

Implements templatable.


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