Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
gradereport_singleview\local\screen\screen Class Reference

Abstract class used as a base for the 3 screens. More...

Inheritance diagram for gradereport_singleview\local\screen\screen:
gradereport_singleview\local\screen\grade_select gradereport_singleview\local\screen\select gradereport_singleview\local\screen\tablelike gradereport_singleview\local\screen\user_select gradereport_singleview\local\screen\grade gradereport_singleview\local\screen\user

Public Member Functions

 __construct (int $courseid, ?int $itemid, ?int $groupid=null)
 Constructor.
 
 display_group_selector ()
 Should we show the 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 default heading for the screen.
 
 html ()
 Get the entire screen as a string.
 
 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.
 

Detailed Description

Abstract class used as a base for the 3 screens.

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

Constructor & Destructor Documentation

◆ __construct()

gradereport_singleview\local\screen\screen::__construct ( int $courseid,
?int $itemid,
?int $groupid = null )

Constructor.

Parameters
int$courseidThe course id
int | null$itemidThe item id
int | null$groupidThe group id

Member Function Documentation

◆ display_group_selector()

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

◆ fetch_grade_or_default()

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

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 )

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\screen::heading ( )

◆ html()

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

◆ init()

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

Override this to init the screen.

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

◆ item_type()

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

◆ load_users()

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

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 ( )

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 ( )

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 ( )

Allow selection of number of items to display per page.

Return values
string

◆ process()

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

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 ( )

Should we show the next prev selector?

Return values
bool

Reimplemented in gradereport_singleview\local\screen\select.

◆ supports_paging()

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

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