A custom renderer class that extends the plugin_renderer_base and is used by the assign module. More...

Inheritance diagram for mod_assign\output\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.

	assign_files (\context $context, $userid, $filearea, $component, $course=null, $coursemodule=null)
	Rendering assignment files.

	format_activity_text ($assign, $cmid)
	Formats activity intro text.

	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.

	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.

	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_assign_attempt_history (\assign_attempt_history $history)
	Output the attempt history for this assignment.

	render_assign_attempt_history_chooser (\assign_attempt_history_chooser $history)
	Output the attempt history chooser for this assignment.

	render_assign_course_index_summary (\assign_course_index_summary $indexsummary)
	Render a course index summary.

	render_assign_feedback_plugin_feedback (\assign_feedback_plugin_feedback $feedbackplugin)
	Render a feedback plugin feedback.

	render_assign_feedback_status (\assign_feedback_status $status)
	Render a table containing all the current grades and feedback.

	render_assign_files (\assign_files $tree)
	Rendering assignment files.

	render_assign_form (\assign_form $form)
	Render the generic form.

	render_assign_grading_summary (\assign_grading_summary $summary)
	Render a table containing the current status of the grading process.

	render_assign_grading_table (\assign_grading_table $table)
	Render the grading table.

	render_assign_gradingmessage (\assign_gradingmessage $result)
	Render a grading message notification.

	render_assign_header (assign_header $header)
	Render the header.

	render_assign_plugin_header (\assign_plugin_header $header)
	Render the header for an individual plugin.

	render_assign_submission_plugin_submission (\assign_submission_plugin_submission $submissionplugin)
	Render a submission plugin submission.

	render_assign_submission_status (assign_submission_status $status)
	Render a table containing the current status of the submission.

	render_assign_submission_status_compact (\assign_submission_status_compact $status)
	Render a compact view of the current status of the submission.

	render_assign_submit_for_grading_page ($page)
	Render the submit for grading page.

	render_assign_user_summary (\assign_user_summary $summary)
	Render the user summary.

	render_footer ()
	Page is done - render the footer.

	render_from_template ($templatename, $context)
	Renders a template by name with the given context.

	render_grading_actionmenu (\mod_assign\output\grading_actionmenu $actionmenu)
	Renders the grading action menu.

	render_grading_app (grading_app $app)
	Defer to template.

	render_override_actionmenu (\mod_assign\output\override_actionmenu $actionmenu)
	Renders the override action menu.

	render_user_submission_actionmenu (\mod_assign\output\user_submission_actionmenu $actionmenu)
	Renders the user submission action menu.

	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.

	submission_actionmenu (\mod_assign\output\actionmenu $actionmenu)
	Renders the submission action menu.

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.

Public Attributes
string	$htmlid
	a unique ID.

Protected Member Functions
	flexible_table (\flexible_table $table, $rowsperpage, $displaylinks)
	Helper method dealing with the fact we can not just fetch the output of flexible_table.

	get_mustache ()
	Return an instance of the mustache class.

	get_portfolio_button (assign_files $tree, stored_file $file)
	Get the portfolio button content for the specified file.

	get_time_remaining (\mod_assign\output\assign_submission_status $status)
	Get the time remaining for a submission.

	htmllize_tree (\assign_files $tree, $dir)
	Internal function - creates htmls structure suitable for YUI tree.

	moodleform (\moodleform $mform)
	Helper method dealing with the fact we can not just fetch the output of moodleforms.

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.

Detailed Description

A custom renderer class that extends the plugin_renderer_base and is used by the assign module.

Copyright: 2012 NetSpot

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

Member Function Documentation

◆ __call()

plugin_renderer_base::__call	(		$method,
			$arguments )

inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters

string	$method
array	$arguments

Return values

mixed

◆ add_action_handler()

renderer_base::add_action_handler	(	component_action	$action,
			$id = null )

inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters

component_action	$action
string	$id

Return values

string id of element, either original submitted or random new if not supplied

◆ assign_files()

mod_assign\output\renderer::assign_files	(	\context	$context,
			$userid,
			$filearea,
			$component,
			$course = null,
			$coursemodule = null )

Rendering assignment files.

Parameters

context	$context
int	$userid
string	$filearea
string	$component
stdClass	$course
stdClass	$coursemodule

Return values

string

◆ flexible_table()

mod_assign\output\renderer::flexible_table	(	\flexible_table	$table,
			$rowsperpage,
			$displaylinks )

protected

Helper method dealing with the fact we can not just fetch the output of flexible_table.

Parameters

flexible_table	$table	The table to render
int	$rowsperpage	How many assignments to render in a page
bool	$displaylinks	- Whether to render links in the table (e.g. downloads would not enable this)

Return values

string HTML

◆ format_activity_text()

mod_assign\output\renderer::format_activity_text	(		$assign,
			$cmid )

Formats activity intro text.

Parameters

object	$assign	Instance of assign.
int	$cmid	Course module ID.

Return values

string

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url	(		$maxwidth = 300,
			$maxheight = 300 )

inherited

Return the site's compact logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url	(		$maxwidth = null,
			$maxheight = 200 )

inherited

Return the site's logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since: 2.9

Return values

Mustache_Engine

◆ get_portfolio_button()

mod_assign\output\renderer::get_portfolio_button	(	assign_files	$tree,
		stored_file	$file )

protected

Get the portfolio button content for the specified file.

Parameters

assign_files	$tree
stored_file	$file

Return values

string

◆ get_time_remaining()

mod_assign\output\renderer::get_time_remaining ( \mod_assign\output\assign_submission_status $status )

protected

Get the time remaining for a submission.

Parameters

mod_assign\output\assign_submission_status $status

Return values

array The first element is the time remaining as a human readable string and the second is a CSS class.

◆ has_started()

renderer_base::has_started ( )

inherited

Returns true is output has already started, and false if not.

Return values

boolean true if the header has been printed.

◆ htmllize_tree()

mod_assign\output\renderer::htmllize_tree	(	\assign_files	$tree,
			$dir )

protected

Internal function - creates htmls structure suitable for YUI tree.

Parameters

assign_files	$tree
array	$dir

Return values

string

◆ image_url()

renderer_base::image_url	(		$imagename,
			$component = 'moodle' )

inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ moodleform()

mod_assign\output\renderer::moodleform ( \moodleform $mform )

protected

Helper method dealing with the fact we can not just fetch the output of moodleforms.

Parameters

moodleform $mform

Return values

string HTML

◆ pix_url()

renderer_base::pix_url	(		$imagename,
			$component = 'moodle' )

inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated: since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

Renders the provided widget and returns the HTML to display it.

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_assign_attempt_history()

mod_assign\output\renderer::render_assign_attempt_history ( \assign_attempt_history $history )

Output the attempt history for this assignment.

Parameters

assign_attempt_history $history

Return values

string

◆ render_assign_attempt_history_chooser()

mod_assign\output\renderer::render_assign_attempt_history_chooser ( \assign_attempt_history_chooser $history )

Output the attempt history chooser for this assignment.

Parameters

assign_attempt_history_chooser $history

Return values

string

◆ render_assign_course_index_summary()

mod_assign\output\renderer::render_assign_course_index_summary ( \assign_course_index_summary $indexsummary )

Render a course index summary.

Parameters

assign_course_index_summary $indexsummary

Return values

string

◆ render_assign_feedback_plugin_feedback()

mod_assign\output\renderer::render_assign_feedback_plugin_feedback ( \assign_feedback_plugin_feedback $feedbackplugin )

Render a feedback plugin feedback.

Parameters

assign_feedback_plugin_feedback $feedbackplugin

Return values

string

◆ render_assign_feedback_status()

mod_assign\output\renderer::render_assign_feedback_status ( \assign_feedback_status $status )

Render a table containing all the current grades and feedback.

Parameters

assign_feedback_status $status

Return values

string

◆ render_assign_files()

mod_assign\output\renderer::render_assign_files ( \assign_files $tree )

Rendering assignment files.

Parameters

assign_files $tree

Return values

string

◆ render_assign_form()

mod_assign\output\renderer::render_assign_form ( \assign_form $form )

Render the generic form.

Parameters

assign_form $form The form to render

Return values

string

◆ render_assign_grading_summary()

mod_assign\output\renderer::render_assign_grading_summary ( \assign_grading_summary $summary )

Render a table containing the current status of the grading process.

Parameters

assign_grading_summary $summary

Return values

string

◆ render_assign_grading_table()

mod_assign\output\renderer::render_assign_grading_table ( \assign_grading_table $table )

Render the grading table.

Parameters

assign_grading_table $table

Return values

string

◆ render_assign_gradingmessage()

mod_assign\output\renderer::render_assign_gradingmessage ( \assign_gradingmessage $result )

Render a grading message notification.

Parameters

assign_gradingmessage $result The result to render

Return values

string

◆ render_assign_header()

mod_assign\output\renderer::render_assign_header ( assign_header $header )

Render the header.

Parameters

assign_header $header

Return values

string

◆ render_assign_plugin_header()

mod_assign\output\renderer::render_assign_plugin_header ( \assign_plugin_header $header )

Render the header for an individual plugin.

Parameters

assign_plugin_header $header

Return values

string

◆ render_assign_submission_plugin_submission()

mod_assign\output\renderer::render_assign_submission_plugin_submission ( \assign_submission_plugin_submission $submissionplugin )

Render a submission plugin submission.

Parameters

assign_submission_plugin_submission $submissionplugin

Return values

string

◆ render_assign_submission_status()

mod_assign\output\renderer::render_assign_submission_status ( assign_submission_status $status )

Render a table containing the current status of the submission.

Parameters

assign_submission_status $status

Return values

string

◆ render_assign_submission_status_compact()

mod_assign\output\renderer::render_assign_submission_status_compact ( \assign_submission_status_compact $status )

Render a compact view of the current status of the submission.

Parameters

assign_submission_status_compact $status

Return values

string

◆ render_assign_submit_for_grading_page()

mod_assign\output\renderer::render_assign_submit_for_grading_page ( $page )

Render the submit for grading page.

Parameters

assign_submit_for_grading_page $page

Return values

string

◆ render_assign_user_summary()

mod_assign\output\renderer::render_assign_user_summary ( \assign_user_summary $summary )

Render the user summary.

Parameters

assign_user_summary $summary The user summary to render

Return values

string

◆ render_footer()

mod_assign\output\renderer::render_footer ( )

Page is done - render the footer.

Return values

void

◆ render_from_template()

renderer_base::render_from_template	(		$templatename,
			$context )

inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since: 2.9

Parameters

array | stdClass $context Context containing data for the template.

Return values

string|boolean

◆ render_grading_actionmenu()

mod_assign\output\renderer::render_grading_actionmenu ( \mod_assign\output\grading_actionmenu $actionmenu )

Renders the grading action menu.

Parameters

mod_assign\output\grading_actionmenu $actionmenu The actionmenu

Return values

string The rendered grading action menu.

◆ render_grading_app()

mod_assign\output\renderer::render_grading_app ( grading_app $app )

Defer to template.

Parameters

grading_app $app - All the data to render the grading app.

◆ render_override_actionmenu()

mod_assign\output\renderer::render_override_actionmenu ( \mod_assign\output\override_actionmenu $actionmenu )

Renders the override action menu.

Parameters

mod_assign\output\override_actionmenu $actionmenu The actionmenu

Return values

string The rendered override action menu.

◆ render_user_submission_actionmenu()

mod_assign\output\renderer::render_user_submission_actionmenu ( \mod_assign\output\user_submission_actionmenu $actionmenu )

Renders the user submission action menu.

Parameters

mod_assign\output\user_submission_actionmenu $actionmenu The actionmenu

Return values

string The rendered action menu.

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated: since Moodle 4.0

Todo: final deprecation. To be removed in Moodle 4.4 MDL-73165.

Parameters

int $headinglevel The heading level we want to check against.

Return values

bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

◆ submission_actionmenu()

mod_assign\output\renderer::submission_actionmenu ( \mod_assign\output\actionmenu $actionmenu )

Renders the submission action menu.

Parameters

mod_assign\output\actionmenu $actionmenu The actionmenu

Return values

string Rendered action menu.

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output

protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer

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

mod/assign/classes/output/renderer.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ assign_files()

◆ flexible_table()

◆ format_activity_text()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ get_portfolio_button()

◆ get_time_remaining()

◆ has_started()

◆ htmllize_tree()

◆ image_url()

◆ moodleform()

◆ pix_url()

◆ prepare_classes()

◆ render()

◆ render_assign_attempt_history()

◆ render_assign_attempt_history_chooser()

◆ render_assign_course_index_summary()

◆ render_assign_feedback_plugin_feedback()

◆ render_assign_feedback_status()

◆ render_assign_files()

◆ render_assign_form()

◆ render_assign_grading_summary()

◆ render_assign_grading_table()

◆ render_assign_gradingmessage()

◆ render_assign_header()

◆ render_assign_plugin_header()

◆ render_assign_submission_plugin_submission()

◆ render_assign_submission_status()

◆ render_assign_submission_status_compact()

◆ render_assign_submit_for_grading_page()

◆ render_assign_user_summary()

◆ render_footer()

◆ render_from_template()

◆ render_grading_actionmenu()

◆ render_grading_app()

◆ render_override_actionmenu()

◆ render_user_submission_actionmenu()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ submission_actionmenu()

Member Data Documentation

◆ $output