Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
gradereport_singleview\local\screen\tablelike Class Reference

The gradebook simple view - base class for the table. More...

Inheritance diagram for gradereport_singleview\local\screen\tablelike:
gradereport_singleview\local\screen\screen gradereport_singleview\local\ui\be_readonly gradereport_singleview\local\screen\grade gradereport_singleview\local\screen\user

Public Member Functions

 bulk_insert ()
 Get the HTML for the bulk insert form.
 
 buttons (bool $disabled=false)
 Get the buttons for saving changes.
 
 definition ()
 Get the table definition.
 
 display_group_selector ()
 Should we show the group selector?
 
 fetch_grade_or_default (grade_item $item, int $userid)
 Get the grade_grade.
 
 format_definition (grade_grade $grade)
 Get a element to generate the HTML for this table row.
 
mixed format_line ($item)
 Format a row of the table.
 
 format_link (string $screen, int $itemid, bool $display=null)
 Create a nice link from a thing (user or grade_item).
 
 headers ()
 Get the table headers.
 
 heading ()
 Get the default heading for the screen.
 
 html ()
 Get the HTML for the whole table.
 
 init (bool $selfitemisempty=false)
 Override this to init the screen.
 
 init_errors ()
 Get the list of errors.
 
 is_readonly ()
 Return true if this is read-only.
 
 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.
 
 set_definition (array $overwrite)
 Set the table definition.
 
 set_headers (array $overwrite)
 Set the table headers.
 
 set_init_error (string $mesg)
 Set an error detected while building the page.
 
 setup_structure ()
 Cache the grade_structure class.
 
 summary ()
 Get the summary for this table.
 
 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.
 
array $definition = []
 Describes the columns in the table $definition.
 
int $groupid
 The currently set groupid (if set) $groupid.
 
array $headers = []
 A list of table headers $headers.
 
int $index
 Table tab index $index.
 
array $initerrors = []
 A list of errors that mean we should not show the table $initerrors.
 
mixed $item
 The grade item or user.
 
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.
 
int $total
 Total items $total.
 

Static Protected Attributes

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

Detailed Description

The gradebook simple view - base class for the table.

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

Get the HTML for the bulk insert form.

Return values
string

◆ buttons()

gradereport_singleview\local\screen\tablelike::buttons ( bool $disabled = false)

Get the buttons for saving changes.

Parameters
bool$disabledIf button is disabled
Return values
array

◆ definition()

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

Get the table definition.

Return values
arrayThe definition.

◆ display_group_selector()

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

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

gradereport_singleview\local\screen\tablelike::format_definition ( grade_grade $grade)

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

Parameters
grade_grade$gradeThe grade.
Return values
array

◆ format_line()

mixed gradereport_singleview\local\screen\tablelike::format_line ( $item)
abstract

Format a row of the table.

$item

Return values
array

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

◆ 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

◆ headers()

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

Get the table headers.

Return values
array

◆ heading()

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

◆ html()

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

Get the HTML for the whole table.

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.

◆ init_errors()

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

Get the list of errors.

Return values
array

◆ is_readonly()

gradereport_singleview\local\screen\tablelike::is_readonly ( )

Return true if this is read-only.

Return values
bool

Implements gradereport_singleview\local\ui\be_readonly.

◆ item_type()

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

◆ 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.

◆ 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.

◆ set_definition()

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

Set the table definition.

Parameters
array$overwriteNew definition
Return values
tablelikeThis

◆ set_headers()

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

Set the table headers.

Parameters
array$overwriteNew headers
Return values
tablelikeThis

◆ set_init_error()

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

Set an error detected while building the page.

Parameters
string$mesg

◆ summary()

gradereport_singleview\local\screen\tablelike::summary ( )
abstract

Get the summary for this table.

Return values
string

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

Member Data Documentation

◆ $item

mixed gradereport_singleview\local\screen\tablelike::$item
protected

The grade item or user.

$item


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