Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
mod_workshop_renderer Class Reference

Workshop module renderer class. More...

Inheritance diagram for mod_workshop_renderer:
plugin_renderer_base renderer_base workshopallocation_manual_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. More...
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id. More...
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any. More...
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any. More...
 
 has_started ()
 Returns true is output has already started, and false if not. More...
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image. More...
 
 perpage_selector ($current=10)
 Renders a perpage selector for workshop listings. More...
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder. More...
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it. More...
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context. More...
 
 should_display_main_logo ($headinglevel=1)
 Whether we should display the main logo. More...
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar. More...
 

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. More...
 

Protected Member Functions

 get_mustache ()
 Return an instance of the mustache class. More...
 
 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. More...
 
 helper_submission_attachments ($submissionid, $format='html')
 Renders a list of files attached to the submission. More...
 
 helper_user_plan_tasks (array $tasks)
 Renders the tasks for the single phase in the user plan. More...
 
 overall_feedback (workshop_assessment $assessment)
 Renders the overall feedback for the author of the submission. More...
 
 render_workshop_allocation_result (workshop_allocation_result $result)
 Renders the result of the submissions allocation process. More...
 
 render_workshop_assessment (workshop_assessment $assessment)
 Renders the full assessment. More...
 
 render_workshop_example_assessment (workshop_example_assessment $assessment)
 Renders the assessment of an example submission. More...
 
 render_workshop_example_reference_assessment (workshop_example_reference_assessment $assessment)
 Renders the reference assessment of an example submission. More...
 
 render_workshop_example_submission (workshop_example_submission $example)
 Renders full workshop example submission. More...
 
 render_workshop_example_submission_summary (workshop_example_submission_summary $summary)
 Renders short summary of the example submission. More...
 
 render_workshop_feedback_author (workshop_feedback_author $feedback)
 Renders the feedback for the author of the submission. More...
 
 render_workshop_feedback_reviewer (workshop_feedback_reviewer $feedback)
 Renders the feedback for the reviewer of the submission. More...
 
 render_workshop_final_grades (workshop_final_grades $grades)
 Renders the user's final grades. More...
 
 render_workshop_grading_report (workshop_grading_report $gradingreport)
 Renders the workshop grading report. More...
 
 render_workshop_message (workshop_message $message)
 Renders workshop message. More...
 
 render_workshop_submission (workshop_submission $submission)
 Renders full workshop submission. More...
 
 render_workshop_submission_summary (workshop_submission_summary $summary)
 Renders short summary of the submission. More...
 
 render_workshop_user_plan (workshop_user_plan $plan)
 Renders the user plannner tool. More...
 

Static Protected Member Functions

static array_nth (array $a, $n)
 Helper function returning the n-th item of the array. More...
 
static fullname_format ()
 Tries to guess the fullname format set at the site. More...
 
static moodleform (moodleform $mform)
 Helper method dealing with the fact we can not just fetch the output of moodleforms. More...
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
renderer_base core_renderer $output
 A reference to the current renderer. More...
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 

Detailed Description

Workshop module renderer class.

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
stringid of element, either original submitted or random new if not supplied

◆ 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$nfrom 0 to m, where m is th number of items in the array
Return values
mixedthe $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
stringfl|lf

◆ 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$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe 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$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe 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

◆ has_started()

renderer_base::has_started ( )
inherited

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

Return values
booleantrue if the header has been printed.

◆ 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$separatorbetween 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$textThe heading text
string$sortidThe column id used for sorting
string$sortbyCurrently sorted by (column id)
string$sorthowCurrently 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$submissionidsubmission identifier
stringformat the format of the returned string - html|text
Return values
stringformatted 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
stringhtml code

◆ 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$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ 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
stringHTML

◆ 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
stringHTML

◆ 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$currentcurrent value of the perpage parameter
Return values
stringHTML

◆ 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$imagenamethe name of the icon.
string$componentspecification 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$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable  $widget)
inherited

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

Parameters
renderable$widgetinstance with renderable interface
Return values
string

Reimplemented from renderer_base.

Reimplemented in tool_policy\output\renderer.

◆ 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$contextContext containing data for the template.
Return values
string|boolean

◆ 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$resultas returned by the allocator's init() method
Return values
stringHTML 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
stringHTML

◆ 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
stringHTML

◆ 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
stringHTML

◆ 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
stringHTML

◆ 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
stringtext 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
stringHTML

◆ 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
stringHTML

◆ 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$gradeswith the info about grades in the gradebook
Return values
stringHTML

◆ 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
stringhtml code

◆ render_workshop_message()

mod_workshop_renderer::render_workshop_message ( workshop_message  $message)
protected

Renders workshop message.

Parameters
workshop_message$messageto display
Return values
stringhtml code

◆ render_workshop_submission()

mod_workshop_renderer::render_workshop_submission ( workshop_submission  $submission)
protected

Renders full workshop submission.

Parameters
workshop_submission$submission
Return values
stringHTML

◆ 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
stringtext 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$planprepared for the user
Return values
stringhtml code to be displayed

◆ should_display_main_logo()

renderer_base::should_display_main_logo (   $headinglevel = 1)
inherited

Whether we should display the main logo.

Parameters
int$headinglevelThe 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

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: