Workshop module renderer class. More...

Inheritance diagram for mod_workshop_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.

	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_bars (workshop $workshop, moodle_url $url)
	Render the initials bars for workshop.

	perpage_selector ($current=10)
	Renders a perpage selector for workshop listings.

	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_buttons (workshop $workshop, workshop_user_plan $userplan)
	Generates the action buttons.

	render_allocation_menu (\mod_workshop\output\actionbar $actionbar)
	Renders the tertiary nav for the allocation pages.

	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.

	view_page (workshop $workshop, workshop_user_plan $userplan, string $currentphasetitle, int $page, string $sortby, string $sorthow)
	Generates the view page.

	view_submissions_report (workshop $workshop, workshop_user_plan $userplan, int $page, string $sortby, string $sorthow)
	Generates the submission report.

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.

	helper_grading_report_assessment ($assessment, $shownames, array $userinfo, $separator)

	helper_grading_report_grade ($grade, $over=null)
	Formats the aggreagated grades.

	helper_grading_report_participant (stdclass $participant, array $userinfo)

	helper_grading_report_submission (stdclass $participant)

	helper_sortable_heading ($text, $sortid=null, $sortby=null, $sorthow=null)
	Renders a text with icons to sort by the given column.

	helper_submission_attachments ($submissionid, $format='html')
	Renders a list of files attached to the submission.

	helper_user_plan_tasks (array $tasks)
	Renders the tasks for the single phase in the user plan.

	overall_feedback (workshop_assessment $assessment)
	Renders the overall feedback for the author of the submission.

	render_workshop_allocation_result (workshop_allocation_result $result)
	Renders the result of the submissions allocation process.

	render_workshop_assessment (workshop_assessment $assessment)
	Renders the full assessment.

	render_workshop_example_assessment (workshop_example_assessment $assessment)
	Renders the assessment of an example submission.

	render_workshop_example_reference_assessment (workshop_example_reference_assessment $assessment)
	Renders the reference assessment of an example submission.

	render_workshop_example_submission (workshop_example_submission $example)
	Renders full workshop example submission.

	render_workshop_example_submission_summary (workshop_example_submission_summary $summary)
	Renders short summary of the example submission.

	render_workshop_feedback_author (workshop_feedback_author $feedback)
	Renders the feedback for the author of the submission.

	render_workshop_feedback_reviewer (workshop_feedback_reviewer $feedback)
	Renders the feedback for the reviewer of the submission.

	render_workshop_final_grades (workshop_final_grades $grades)
	Renders the user's final grades.

	render_workshop_grading_report (workshop_grading_report $gradingreport)
	Renders the workshop grading report.

	render_workshop_message (workshop_message $message)
	Renders workshop message.

	render_workshop_submission (workshop_submission $submission)
	Renders full workshop submission.

	render_workshop_submission_summary (workshop_submission_summary $summary)
	Renders short summary of the submission.

	render_workshop_user_plan (workshop_user_plan $plan)
	Renders the user plannner tool.

Static Protected Member Functions
static	array_nth (array $a, $n)
	Helper function returning the n-th item of the array.

static	fullname_format ()
	Tries to guess the fullname format set at the site.

static	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

Workshop module renderer class.

Copyright: 2009 David Mudrak david.nosp@m..mud.nosp@m.rak@g.nosp@m.mail.nosp@m..com

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

Member Function Documentation

◆ array_nth()

static mod_workshop_renderer::array_nth	(	array	$a,
			$n )

staticprotected

Helper function returning the n-th item of the array.

Parameters

array	$a
int	$n	from 0 to m, where m is th number of items in the array

Return values

mixed the $n-th element of $a

◆ fullname_format()

static mod_workshop_renderer::fullname_format ( )

staticprotected

Tries to guess the fullname format set at the site.

Return values

string fl|lf

◆ helper_grading_report_assessment()

mod_workshop_renderer::helper_grading_report_assessment	(		$assessment,
			$shownames,
		array	$userinfo,
			$separator )

protected

Todo: Highlight the nulls

Parameters

stdClass \| null	$assessment
bool	$shownames
string	$separator	between the grade and the reviewer/author

Return values

string

◆ helper_grading_report_participant()

mod_workshop_renderer::helper_grading_report_participant	(	stdclass	$participant,
		array	$userinfo )

protected

Parameters

stdClass	$participant
array	$userinfo

Return values

string

◆ helper_grading_report_submission()

mod_workshop_renderer::helper_grading_report_submission ( stdclass $participant )

protected

Parameters

stdClass $participant

Return values

string

◆ helper_sortable_heading()

mod_workshop_renderer::helper_sortable_heading	(	$text,
		$sortid = null,
		$sortby = null,
		$sorthow = null )

protected

Renders a text with icons to sort by the given column.

This is intended for table headings.

Parameters

string	$text	The heading text
string	$sortid	The column id used for sorting
string	$sortby	Currently sorted by (column id)
string	$sorthow	Currently sorted how (ASC\|DESC)

Return values

string

◆ helper_submission_attachments()

mod_workshop_renderer::helper_submission_attachments	(		$submissionid,
			$format = 'html' )

protected

Renders a list of files attached to the submission.

If format==html, then format a html string. If format==text, then format a text-only string. Otherwise, returns html for non-images and html to display the image inline.

Parameters

int	$submissionid	submission identifier
	string	format the format of the returned string - html\|text

Return values

string formatted text to be echoed

◆ helper_user_plan_tasks()

mod_workshop_renderer::helper_user_plan_tasks ( array $tasks )

protected

Renders the tasks for the single phase in the user plan.

Parameters

stdClass $tasks

Return values

string html code

◆ initials_bars()

mod_workshop_renderer::initials_bars	(	workshop	$workshop,
		moodle_url	$url )

Render the initials bars for workshop.

Parameters

workshop	$workshop	the current workshop of initial bars.
moodle_url	$url	base URL object.

Return values

string HTML.

◆ moodleform()

static mod_workshop_renderer::moodleform ( moodleform $mform )

staticprotected

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

Parameters

moodleform $mform

Return values

string HTML

◆ overall_feedback()

mod_workshop_renderer::overall_feedback ( workshop_assessment $assessment )

protected

Renders the overall feedback for the author of the submission.

Parameters

workshop_assessment $assessment

Return values

string HTML

◆ perpage_selector()

mod_workshop_renderer::perpage_selector ( $current = 10 )

Renders a perpage selector for workshop listings.

The scripts using this have to define the $PAGE->url prior to calling this and deal with eventually submitted value themselves.

Parameters

int $current current value of the perpage parameter

Return values

string HTML

◆ render_action_buttons()

mod_workshop_renderer::render_action_buttons	(	workshop	$workshop,
		workshop_user_plan	$userplan )

Generates the action buttons.

Parameters

workshop	$workshop	The current workshop.
workshop_user_plan	$userplan	An individual workshop plan for the user.

Return values

string HTML to display.

◆ render_allocation_menu()

mod_workshop_renderer::render_allocation_menu ( \mod_workshop\output\actionbar $actionbar )

Renders the tertiary nav for the allocation pages.

Parameters

mod_workshop\output\actionbar $actionbar

Return values

bool|string the rendered output

◆ render_workshop_allocation_result()

mod_workshop_renderer::render_workshop_allocation_result ( workshop_allocation_result $result )

protected

Renders the result of the submissions allocation process.

Parameters

workshop_allocation_result $result as returned by the allocator's init() method

Return values

string HTML to be echoed

◆ render_workshop_assessment()

mod_workshop_renderer::render_workshop_assessment ( workshop_assessment $assessment )

protected

Renders the full assessment.

Parameters

workshop_assessment $assessment

Return values

string HTML

◆ render_workshop_example_assessment()

mod_workshop_renderer::render_workshop_example_assessment ( workshop_example_assessment $assessment )

protected

Renders the assessment of an example submission.

Parameters

workshop_example_assessment $assessment

Return values

string HTML

◆ render_workshop_example_reference_assessment()

mod_workshop_renderer::render_workshop_example_reference_assessment ( workshop_example_reference_assessment $assessment )

protected

Renders the reference assessment of an example submission.

Parameters

workshop_example_reference_assessment $assessment

Return values

string HTML

◆ render_workshop_example_submission()

mod_workshop_renderer::render_workshop_example_submission ( workshop_example_submission $example )

protected

Renders full workshop example submission.

Parameters

workshop_example_submission $example

Return values

string HTML

◆ render_workshop_example_submission_summary()

mod_workshop_renderer::render_workshop_example_submission_summary ( workshop_example_submission_summary $summary )

protected

Renders short summary of the example submission.

Parameters

workshop_example_submission_summary $summary

Return values

string text to be echo'ed

◆ render_workshop_feedback_author()

mod_workshop_renderer::render_workshop_feedback_author ( workshop_feedback_author $feedback )

protected

Renders the feedback for the author of the submission.

Parameters

workshop_feedback_author $feedback

Return values

string HTML

◆ render_workshop_feedback_reviewer()

mod_workshop_renderer::render_workshop_feedback_reviewer ( workshop_feedback_reviewer $feedback )

protected

Renders the feedback for the reviewer of the submission.

Parameters

workshop_feedback_reviewer $feedback

Return values

string HTML

◆ render_workshop_final_grades()

mod_workshop_renderer::render_workshop_final_grades ( workshop_final_grades $grades )

protected

Renders the user's final grades.

Parameters

workshop_final_grades $grades with the info about grades in the gradebook

Return values

string HTML

◆ render_workshop_grading_report()

mod_workshop_renderer::render_workshop_grading_report ( workshop_grading_report $gradingreport )

protected

Renders the workshop grading report.

Parameters

workshop_grading_report $gradingreport

Return values

string html code

◆ render_workshop_message()

mod_workshop_renderer::render_workshop_message ( workshop_message $message )

protected

Renders workshop message.

Parameters

workshop_message $message to display

Return values

string html code

◆ render_workshop_submission()

mod_workshop_renderer::render_workshop_submission ( workshop_submission $submission )

protected

Renders full workshop submission.

Parameters

workshop_submission $submission

Return values

string HTML

◆ render_workshop_submission_summary()

mod_workshop_renderer::render_workshop_submission_summary ( workshop_submission_summary $summary )

protected

Renders short summary of the submission.

Parameters

workshop_submission_summary $summary

Return values

string text to be echo'ed

◆ render_workshop_user_plan()

mod_workshop_renderer::render_workshop_user_plan ( workshop_user_plan $plan )

protected

Renders the user plannner tool.

Parameters

workshop_user_plan $plan prepared for the user

Return values

string html code to be displayed

◆ view_page()

mod_workshop_renderer::view_page	(	workshop	$workshop,
		workshop_user_plan	$userplan,
		string	$currentphasetitle,
		int	$page,
		string	$sortby,
		string	$sorthow )

Generates the view page.

Parameters

workshop	$workshop	The current workshop.
workshop_user_plan	$userplan	An individual workshop plan for the user.
string	$currentphasetitle	The current phase title.
int	$page	The current page (for the pagination).
string	$sortby	Lastname\|firstname\|submissiontitle\|submissiongrade\|gradinggrade.
string	$sorthow	ASC\|DESC.

Return values

string HTML to display.

◆ view_submissions_report()

mod_workshop_renderer::view_submissions_report	(	workshop	$workshop,
		workshop_user_plan	$userplan,
		int	$page,
		string	$sortby,
		string	$sorthow )

Generates the submission report.

Parameters

workshop	$workshop	The current workshop.
workshop_user_plan	$userplan	An individual workshop plan for the user.
int	$page	The current page (for the pagination).
string	$sortby	Lastname\|firstname\|submissiontitle\|submissiongrade\|gradinggrade.
string	$sorthow	ASC\|DESC.

Return values

string HTML to display.

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

mod/workshop/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ array_nth()

◆ fullname_format()

◆ helper_grading_report_assessment()

◆ helper_grading_report_participant()

◆ helper_grading_report_submission()

◆ helper_sortable_heading()

◆ helper_submission_attachments()

◆ helper_user_plan_tasks()

◆ initials_bars()

◆ moodleform()

◆ overall_feedback()

◆ perpage_selector()

◆ render_action_buttons()

◆ render_allocation_menu()

◆ render_workshop_allocation_result()

◆ render_workshop_assessment()

◆ render_workshop_example_assessment()

◆ render_workshop_example_reference_assessment()

◆ render_workshop_example_submission()

◆ render_workshop_example_submission_summary()

◆ render_workshop_feedback_author()

◆ render_workshop_feedback_reviewer()

◆ render_workshop_final_grades()

◆ render_workshop_grading_report()

◆ render_workshop_message()

◆ render_workshop_submission()

◆ render_workshop_submission_summary()

◆ render_workshop_user_plan()

◆ view_page()

◆ view_submissions_report()