Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
The user screen. More...
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. | |
description () | |
Get the description for the screen. | |
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. | |
format_line ($item) | |
Format each 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 heading for the page. | |
html () | |
Get the HTML for the whole table. | |
init (bool $selfitemisempty=false) | |
Override this to init the screen. | |
init ($selfitemisempty=false) | |
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 on this screen. | |
js () | |
Initialise the js for this screen. | |
options () | |
Convert the list of items to a list of options. | |
original_headers () | |
Get the list of headers for the table. | |
pager () | |
Default pager. | |
perpage_select () | |
Allow selection of number of items to display per page. | |
process ($data) | |
Process the data from the form. | |
select_label () | |
Get the label for the select box that chooses items for this page. | |
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 page require paging? | |
Public Attributes | |
array | $item = [] |
get a valid user. | |
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. | |
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. | |
The user screen.
|
inherited |
Get the HTML for the bulk insert form.
string |
|
inherited |
Get the buttons for saving changes.
bool | $disabled | If button is disabled |
array |
|
inherited |
Get the table definition.
array | The definition. |
gradereport_singleview\local\screen\user::description | ( | ) |
Get the description for the screen.
string |
Implements gradereport_singleview\local\screen\selectable_items.
|
inherited |
Should we show the group selector?
bool |
Reimplemented in gradereport_singleview\local\screen\grade_select, gradereport_singleview\local\screen\select, and gradereport_singleview\local\screen\user_select.
|
inherited |
Get the grade_grade.
grade_item | $item | The grade_item |
int | $userid | The user id |
grade_grade |
|
inherited |
Get a element to generate the HTML for this table row.
grade_grade | $grade | The grade. |
array |
gradereport_singleview\local\screen\user::format_line | ( | $item | ) |
Format each row of the table.
grade_item | $item |
array |
Reimplemented from gradereport_singleview\local\screen\tablelike.
|
inherited |
Create a nice link from a thing (user or grade_item).
string | $screen | |
int | $itemid | |
bool | null | $display | Should we wrap this in an anchor ? |
string | The link |
|
inherited |
Get the table headers.
array |
gradereport_singleview\local\screen\user::heading | ( | ) |
Get the heading for the page.
string |
Reimplemented from gradereport_singleview\local\screen\screen.
|
inherited |
Get the HTML for the whole table.
string |
Reimplemented from gradereport_singleview\local\screen\screen.
|
abstractinherited |
Override this to init the screen.
boolean | $selfitemisempty | True if no item has been selected yet. |
gradereport_singleview\local\screen\user::init | ( | $selfitemisempty = false | ) |
Init the screen.
bool | $selfitemisempty | Have we selected an item yet? |
|
inherited |
Get the list of errors.
array |
|
inherited |
Return true if this is read-only.
bool |
Implements gradereport_singleview\local\ui\be_readonly.
gradereport_singleview\local\screen\user::item_type | ( | ) |
Get the type of items on this screen.
string |
Reimplemented from gradereport_singleview\local\screen\screen.
|
protectedinherited |
Load a valid list of users for this gradebook as the screen "items".
array | A list of enroled users. |
gradereport_singleview\local\screen\user::options | ( | ) |
Convert the list of items to a list of options.
array |
Reimplemented from gradereport_singleview\local\screen\screen.
gradereport_singleview\local\screen\user::original_headers | ( | ) |
Get the list of headers for the table.
array | List of headers |
gradereport_singleview\local\screen\user::pager | ( | ) |
|
inherited |
Allow selection of number of items to display per page.
string |
gradereport_singleview\local\screen\user::process | ( | $data | ) |
Process the data from the form.
array | $data |
stdClass | of warnings |
Reimplemented from gradereport_singleview\local\screen\screen.
gradereport_singleview\local\screen\user::select_label | ( | ) |
Get the label for the select box that chooses items for this page.
string |
Implements gradereport_singleview\local\screen\selectable_items.
|
inherited |
Set the table definition.
array | $overwrite | New definition |
tablelike | This |
|
inherited |
Set the table headers.
array | $overwrite | New headers |
tablelike | This |
|
inherited |
Set an error detected while building the page.
string | $mesg |
gradereport_singleview\local\screen\user::summary | ( | ) |
Get the summary for this table.
string |
Reimplemented from gradereport_singleview\local\screen\tablelike.
|
inherited |
Should we show the next prev selector?
bool |
Reimplemented in gradereport_singleview\local\screen\select.
gradereport_singleview\local\screen\user::supports_paging | ( | ) |
Does this page require paging?
bool |
Reimplemented from gradereport_singleview\local\screen\screen.
array gradereport_singleview\local\screen\user::$item = [] |
get a valid user.