core_grades_renderer Class Reference

Inheritance diagram for core_grades_renderer:

Public Member Functions
	__call ($method, $arguments)
	Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.
	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.
	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.
	get_page ()
	Returns the moodle page object.
	group_selector (object $course, ?string $groupactionbaseurl=null)
	Renders the group selector trigger element.
	has_started ()
	Returns true is output has already started, and false if not.
	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image.
	initials_selector (object $course, context $context, string $slug)
	Build the data to render the initials bar filter within the gradebook.
	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.
	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it.
	render_action_bar (action_bar $actionbar)
	Renders the action bar for a given page.
	render_from_template ($templatename, $context)
	Renders a template by name with the given context.
	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo.
	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.
	user_heading (stdClass $user, int $courseid, bool $showbuttons=true)
	Creates and renders a custom user heading.

Static Public Member Functions
static	prepare_classes ($classes)
	Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Protected Member Functions
	get_mustache ()
	Return an instance of the mustache class.

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.
renderer_base core_renderer	$output
	A reference to the current renderer.
moodle_page	$page
	The Moodle page the renderer has been created to assist with.
string	$target
	The requested rendering target.
array	$templatecache = []
	$templatecache The mustache template cache.

Member Function Documentation

group_selector()

core_grades_renderer::group_selector	(	object	$course,
		?string	$groupactionbaseurl = null )

Renders the group selector trigger element.

Parameters

object	$course	The course object.
string | null	$groupactionbaseurl	This parameter has been deprecated since 4.4 and should not be used anymore.

Return values

string|null

The raw HTML to render.

initials_selector()

core_grades_renderer::initials_selector	(	object	$course,
		context	$context,
		string	$slug )

Build the data to render the initials bar filter within the gradebook.

Using this initials selector means you'll have to retain the use of the templates & JS to handle form submission. If a simple redirect on each selection is desired the standard user_search() within the user renderer is what you are after.

Parameters

object	$course	The course object.
context	$context	Our current context.
string	$slug	The slug for the report that called this function.

Return values

stdClass

The data to output.

render_action_bar()

core_grades_renderer::render_action_bar

(

action_bar

$actionbar

)

Renders the action bar for a given page.

Parameters

action_bar

$actionbar

Return values

string

The HTML output

user_heading()

core_grades_renderer::user_heading	(	stdClass	$user,
		int	$courseid,
		bool	$showbuttons = true )

Creates and renders a custom user heading.

Parameters

stdClass	$user	The user object.
int	$courseid	The course ID.
bool	$showbuttons	Whether to display buttons (message, add to contacts) within the heading.

Return values

string

The raw HTML to render.

---

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

• grade/renderer.php