Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
gradereport_singleview\local\screen\grade_select Class Reference
Inheritance diagram for gradereport_singleview\local\screen\grade_select:
gradereport_singleview\local\screen\screen

Public Member Functions

 display_group_selector ()
 Should we show the base singlereport group selector?
 
 fetch_grade_or_default (grade_item $item, int $userid)
 Get the grade_grade.
 
 format_link (string $screen, int $itemid, bool $display=null)
 Create a nice link from a thing (user or grade_item).
 
 heading ()
 Get the heading for the screen.
 
 html ()
 Return the HTML for the page.
 
 init ($selfitemisempty=false)
 
 init (bool $selfitemisempty=false)
 Override this to init the screen.
 
 item_type ()
 Get the type of items in the list.
 
 js ()
 Initialise the js for this screen.
 
 options ()
 By default, there are no options.
 
 pager ()
 Default pager.
 
 perpage_select ()
 Allow selection of number of items to display per page.
 
 process ($data)
 Process the data from a form submission.
 
 setup_structure ()
 Cache the grade_structure class.
 
 supports_next_prev ()
 Should we show the next prev selector?
 
 supports_paging ()
 Does this screen support paging?
 

Protected Member Functions

 load_users ()
 Load a valid list of users for this gradebook as the screen "items".
 

Protected Attributes

context_course $context
 The course context $context.
 
stdClass $course
 To store course data.
 
int $courseid
 The id of the course $courseid.
 
int $groupid
 The currently set groupid (if set) $groupid.
 
int null $itemid
 Either a user id or a grade_item id $itemid.
 
array $items
 List of items on the page, they could be users or grade_items $items.
 
int $page
 The page number $page.
 
int $perpage
 Results per page $perpage.
 
grade_structure $structure
 General structure representing grade items in course.
 

Static Protected Attributes

static int $maxperpage = 5000
 Maximum number of students that can be shown on one page.
 
static array $validperpage = [20, 100]
 List of allowed values for 'perpage' setting $validperpage.
 

Member Function Documentation

◆ display_group_selector()

gradereport_singleview\local\screen\grade_select::display_group_selector ( )

Should we show the base singlereport group selector?

Return values
bool

Reimplemented from gradereport_singleview\local\screen\screen.

◆ fetch_grade_or_default()

gradereport_singleview\local\screen\screen::fetch_grade_or_default ( grade_item $item,
int $userid )
inherited

Get the grade_grade.

Parameters
grade_item$itemThe grade_item
int$useridThe user id
Return values
grade_grade

◆ format_link()

gradereport_singleview\local\screen\screen::format_link ( string $screen,
int $itemid,
bool $display = null )
inherited

Create a nice link from a thing (user or grade_item).

Parameters
string$screen
int$itemid
bool | null$displayShould we wrap this in an anchor ?
Return values
stringThe link

◆ heading()

gradereport_singleview\local\screen\grade_select::heading ( )

Get the heading for the screen.

Return values
string

Reimplemented from gradereport_singleview\local\screen\screen.

◆ html()

gradereport_singleview\local\screen\grade_select::html ( )

Return the HTML for the page.

Return values
string

Reimplemented from gradereport_singleview\local\screen\screen.

◆ init()

gradereport_singleview\local\screen\screen::init ( bool $selfitemisempty = false)
abstractinherited

Override this to init the screen.

Parameters
boolean$selfitemisemptyTrue if no item has been selected yet.

◆ item_type()

gradereport_singleview\local\screen\grade_select::item_type ( )

Get the type of items in the list.

Return values
null|string

Reimplemented from gradereport_singleview\local\screen\screen.

◆ load_users()

gradereport_singleview\local\screen\screen::load_users ( )
protectedinherited

Load a valid list of users for this gradebook as the screen "items".

Deprecated
since Moodle 4.3
Return values
arrayA list of enroled users.

◆ options()

gradereport_singleview\local\screen\screen::options ( )
inherited

By default, there are no options.

Return values
array

Reimplemented in gradereport_singleview\local\screen\grade, and gradereport_singleview\local\screen\user.

◆ pager()

gradereport_singleview\local\screen\screen::pager ( )
inherited

Default pager.

Return values
string

Reimplemented in gradereport_singleview\local\screen\grade, and gradereport_singleview\local\screen\user.

◆ perpage_select()

gradereport_singleview\local\screen\screen::perpage_select ( )
inherited

Allow selection of number of items to display per page.

Return values
string

◆ process()

gradereport_singleview\local\screen\screen::process ( $data)
inherited

Process the data from a form submission.

Parameters
array | object$data
Return values
stdClassof warnings

Reimplemented in gradereport_singleview\local\screen\grade, and gradereport_singleview\local\screen\user.

◆ supports_next_prev()

gradereport_singleview\local\screen\screen::supports_next_prev ( )
inherited

Should we show the next prev selector?

Return values
bool

Reimplemented in gradereport_singleview\local\screen\select.

◆ supports_paging()

gradereport_singleview\local\screen\grade_select::supports_paging ( )

Does this screen support paging?

Return values
bool

Reimplemented from gradereport_singleview\local\screen\screen.


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