Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
gradereport_singleview\local\screen\user Class Reference

The user screen. More...

Inheritance diagram for gradereport_singleview\local\screen\user:
gradereport_singleview\local\screen\tablelike gradereport_singleview\local\screen\selectable_items gradereport_singleview\local\screen\screen

Public Member Functions

 bulk_insert ()
 Get the HTML for the bulk insert form. More...
 
 buttons ()
 Get the buttons for saving changes. More...
 
 definition ()
 Get the table definition. More...
 
 description ()
 Get the description for the screen. More...
 
 display_group_selector ()
 Should we show the group selector? More...
 
 fetch_grade_or_default ($item, $userid)
 Get the grade_grade. More...
 
 format_definition ($line, $grade)
 Get a element to generate the HTML for this table row. More...
 
 format_line ($item)
 Format each row of the table. More...
 
 format_link ($screen, $itemid, $display=null)
 Create a nice link from a thing (user or grade_item). More...
 
 headers ()
 Get the table headers. More...
 
 heading ()
 Get the heading for the page. More...
 
 html ()
 Get the HTML for the whole table. More...
 
 init ($selfitemisempty=false)
 Init the screen. More...
 
 init_errors ()
 Get the list of errors. More...
 
 item_type ()
 Get the type of items on this screen. More...
 
 js ()
 Initialise the js for this screen.
 
 make_toggle ($key)
 Make the HTML element that toggles all the checkboxes on or off. More...
 
 make_toggle_links ($key)
 Make a toggle link with some text before it. More...
 
 options ()
 Convert the list of items to a list of options. More...
 
 original_headers ()
 Get the list of headers for the table. More...
 
 pager ()
 Default pager. More...
 
 perpage_select ()
 Allow selection of number of items to display per page. More...
 
 process ($data)
 Process the data from the form. More...
 
 select_label ()
 Get the label for the select box that chooses items for this page. More...
 
 set_definition ($overwrite)
 Set the table definition. More...
 
 set_headers ($overwrite)
 Set the table headers. More...
 
 set_init_error ($mesg)
 Set an error detected while building the page. More...
 
 setup_structure ()
 Cache the grade_structure class.
 
 summary ()
 Get the summary for this table. More...
 
 supports_next_prev ()
 Should we show the next prev selector? More...
 
 supports_paging ()
 Does this page require paging? More...
 

Protected Member Functions

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

Protected Attributes

course_context $context
 $context The course context
 
int $courseid
 $courseid The id of the course
 
array $definition = array()
 $definition Describes the columns in the table
 
int $groupid
 $groupid The currently set groupid (if set)
 
array $headers = array()
 $headers A list of table headers
 
array $initerrors = array()
 $initerrors A list of errors that mean we should not show the table
 
int $itemid
 $itemid Either a user id or a grade_item id
 
array $items
 $items List of items on the page, they could be users or grade_items
 
int $page
 $page The page number
 
int $perpage
 $perpage Results per page
 

Static Protected Attributes

static array $validperpage = [20, 50, 100, 200, 400, 1000, 5000]
 $validperpage List of allowed values for 'perpage' setting
 

Detailed Description

The user screen.

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

Member Function Documentation

◆ bulk_insert()

gradereport_singleview\local\screen\tablelike::bulk_insert ( )
inherited

Get the HTML for the bulk insert form.

Return values
string

◆ buttons()

gradereport_singleview\local\screen\tablelike::buttons ( )
inherited

Get the buttons for saving changes.

Return values
array

◆ definition()

gradereport_singleview\local\screen\tablelike::definition ( )
inherited

Get the table definition.

Return values
arrayThe definition.

◆ description()

gradereport_singleview\local\screen\user::description ( )

Get the description for the screen.

Return values
string

Implements gradereport_singleview\local\screen\selectable_items.

◆ display_group_selector()

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

Should we show the group selector?

Return values
bool

◆ fetch_grade_or_default()

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

Get the grade_grade.

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

◆ format_definition()

gradereport_singleview\local\screen\tablelike::format_definition (   $line,
  $grade 
)
inherited

Get a element to generate the HTML for this table row.

Parameters
array$lineThis is a list of lines in the table (modified)
grade_grade$gradeThe grade.
Return values
string

◆ format_line()

gradereport_singleview\local\screen\user::format_line (   $item)

Format each row of the table.

Parameters
grade_item$item
Return values
string

Reimplemented from gradereport_singleview\local\screen\tablelike.

◆ format_link()

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

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

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

◆ headers()

gradereport_singleview\local\screen\tablelike::headers ( )
inherited

Get the table headers.

Return values
array

◆ heading()

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

Get the heading for the page.

Return values
string

Reimplemented from gradereport_singleview\local\screen\screen.

◆ html()

gradereport_singleview\local\screen\tablelike::html ( )
inherited

Get the HTML for the whole table.

Return values
string

Reimplemented from gradereport_singleview\local\screen\screen.

◆ init()

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

Init the screen.

Parameters
bool$selfitemisemptyHave we selected an item yet?

Reimplemented from gradereport_singleview\local\screen\screen.

◆ init_errors()

gradereport_singleview\local\screen\tablelike::init_errors ( )
inherited

Get the list of errors.

Return values
array

◆ item_type()

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

Get the type of items on this screen.

Return values
string

Implements gradereport_singleview\local\screen\selectable_items.

◆ load_users()

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

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

Return values
array::$usersA list of enroled users.

◆ make_toggle()

gradereport_singleview\local\screen\screen::make_toggle (   $key)
inherited

Make the HTML element that toggles all the checkboxes on or off.

Parameters
string$keyA unique key for this control - inserted in the classes.
Return values
string

◆ make_toggle_links()

gradereport_singleview\local\screen\screen::make_toggle_links (   $key)
inherited

Make a toggle link with some text before it.

Parameters
string$keyA unique key for this control - inserted in the classes.
Return values
string

◆ options()

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

Convert the list of items to a list of options.

Return values
array

Implements gradereport_singleview\local\screen\selectable_items.

◆ original_headers()

gradereport_singleview\local\screen\user::original_headers ( )

Get the list of headers for the table.

Return values
arrayList of headers

◆ pager()

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

Default pager.

Return values
string

Reimplemented from gradereport_singleview\local\screen\screen.

◆ 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\user::process (   $data)

Process the data from the form.

Parameters
array$data
Return values
arrayof warnings

Reimplemented from gradereport_singleview\local\screen\screen.

◆ select_label()

gradereport_singleview\local\screen\user::select_label ( )

Get the label for the select box that chooses items for this page.

Return values
string

Implements gradereport_singleview\local\screen\selectable_items.

◆ set_definition()

gradereport_singleview\local\screen\tablelike::set_definition (   $overwrite)
inherited

Set the table definition.

Parameters
array$overwriteNew definition
Return values
tablelikeThis

◆ set_headers()

gradereport_singleview\local\screen\tablelike::set_headers (   $overwrite)
inherited

Set the table headers.

Parameters
array$overwriteNew headers
Return values
tablelikeThis

◆ set_init_error()

gradereport_singleview\local\screen\tablelike::set_init_error (   $mesg)
inherited

Set an error detected while building the page.

Parameters
string$mesg

◆ summary()

gradereport_singleview\local\screen\user::summary ( )

Get the summary for this table.

Return values
string

Reimplemented from gradereport_singleview\local\screen\tablelike.

◆ 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\user::supports_paging ( )

Does this page require paging?

Return values
bool

Reimplemented from gradereport_singleview\local\screen\screen.


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