Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]
Abstract class used as a base for the 3 screens.
| Copyright: | 2014 Moodle Pty Ltd (http://moodle.com) |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 441 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
screen:: (14 methods):
__construct()
setup_structure()
format_link()
fetch_grade_or_default()
heading()
supports_paging()
pager()
js()
process()
options()
display_group_selector()
supports_next_prev()
load_users()
perpage_select()
Abstract class used as a base for the 3 screens.
| __construct(int $courseid, ?int $itemid, ?int $groupid = null) X-Ref |
| Constructor param: int $courseid The course id param: int|null $itemid The item id param: int|null $groupid The group id |
| setup_structure() X-Ref |
| Cache the grade_structure class |
| format_link(string $screen, int $itemid, bool $display = null) X-Ref |
| Create a nice link from a thing (user or grade_item). param: string $screen param: int $itemid param: bool|null $display Should we wrap this in an anchor ? return: string The link |
| fetch_grade_or_default(grade_item $item, int $userid) X-Ref |
| Get the grade_grade param: grade_item $item The grade_item param: int $userid The user id return: grade_grade |
| heading() X-Ref |
| Get the default heading for the screen. return: string |
| supports_paging() X-Ref |
| Does this screen support paging? return: bool |
| pager() X-Ref |
| Default pager return: string |
| js() X-Ref |
| Initialise the js for this screen. |
| process($data) X-Ref |
| Process the data from a form submission. param: array|object $data return: stdClass of warnings |
| options() X-Ref |
| By default, there are no options. return: array |
| display_group_selector() X-Ref |
| Should we show the group selector? return: bool |
| supports_next_prev() X-Ref |
| Should we show the next prev selector? return: bool |
| load_users() X-Ref |
| Load a valid list of users for this gradebook as the screen "items". return: array $users A list of enroled users. |
| perpage_select() X-Ref |
| Allow selection of number of items to display per page. return: string |
