gradereport_singleview\local\screen\select Class Reference

The gradebook simple view - initial view to select your search options. More...

Inheritance diagram for gradereport_singleview\local\screen\select:

Public Member Functions
	display_group_selector ()
	Should we show the base singlereport 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 heading for the screen.
	html ()
	Return the HTML for the page.
	init (bool $selfitemisempty=false)
	Override this to init the screen.
	init ($selfitemisempty=false)
	Initialise this screen.
	item_type ()
	Get the type of items on this screen, not valid so return false.
	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?

Public Attributes
stdClass	$item
	course data.

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 array	$validperpage = [20, 50, 100, 200, 400, 1000, 5000]
	List of allowed values for 'perpage' setting $validperpage.

Detailed Description

The gradebook simple view - initial view to select your search options.

Copyright

2014 Moodle Pty Ltd (http://moodle.com)

License

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

Member Function Documentation

display_group_selector()

gradereport_singleview\local\screen\select::display_group_selector

(

)

Should we show the base singlereport group selector?

Return values

bool

Reimplemented from gradereport_singleview\local\screen\screen.

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	$item	The grade_item
int	$userid	The user id

Return values

grade_grade

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	$display	Should we wrap this in an anchor ?

Return values

string

The link

heading()

gradereport_singleview\local\screen\select::heading

(

)

Get the heading for the screen.

Return values

string

Reimplemented from gradereport_singleview\local\screen\screen.

html()

gradereport_singleview\local\screen\select::html

(

)

Return the HTML for the page.

Return values

string

Reimplemented from gradereport_singleview\local\screen\screen.

init() [1/2]

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

abstractinherited

Override this to init the screen.

Parameters

boolean

$selfitemisempty

True if no item has been selected yet.

init() [2/2]

gradereport_singleview\local\screen\select::init

(

$selfitemisempty = false

)

Initialise this screen.

Parameters

bool

$selfitemisempty

Has an item been selected (will be false)

item_type()

gradereport_singleview\local\screen\select::item_type

(

)

Get the type of items on this screen, not valid so return false.

Return values

string|null

Reimplemented from gradereport_singleview\local\screen\screen.

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\$users

A 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

stdClass

of warnings

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

supports_next_prev()

gradereport_singleview\local\screen\select::supports_next_prev

(

)

Should we show the next prev selector?

Return values

bool

Reimplemented from gradereport_singleview\local\screen\screen.

supports_paging()

gradereport_singleview\local\screen\select::supports_paging

(

)

Does this screen support paging?

Return values

bool

Reimplemented from gradereport_singleview\local\screen\screen.

---

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

• grade/report/singleview/classes/local/screen/select.php