Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
workshopallocation_manual_renderer Class Reference

Manual allocation renderer class. More...

Inheritance diagram for workshopallocation_manual_renderer:
mod_workshop_renderer plugin_renderer_base renderer_base

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.
 
 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_participant (stdclass $allocation, array $userinfo)
 Returns information about the workshop participant.
 
 helper_remove_allocation_icon ($link)
 Generates an icon link to remove the allocation.
 
 helper_reviewees_of_participant (stdclass $allocation, array $userinfo, array $authors, $selfassessment)
 Returns information about the current reviewees of the given participant and a selector do add new one.
 
 helper_reviewers_of_participant (stdclass $allocation, array $userinfo, array $reviewers, $selfassessment)
 Returns information about the current reviewers of the given participant and a selector do add new one.
 
 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.
 
 render_workshopallocation_manual_allocations (workshopallocation_manual_allocations $data)
 Display the table of all current allocations and widgets to modify them.
 

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.
 
workshop $workshop
 module instance
 

Detailed Description

Manual allocation renderer class.

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 )
staticprotectedinherited

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 ( )
staticprotectedinherited

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 )
protectedinherited
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 )
protectedinherited
Parameters
stdClass$participant
array$userinfo
Return values
string

◆ helper_grading_report_submission()

mod_workshop_renderer::helper_grading_report_submission ( stdclass $participant)
protectedinherited
Parameters
stdClass$participant
Return values
string

◆ helper_participant()

workshopallocation_manual_renderer::helper_participant ( stdclass $allocation,
array $userinfo )
protected

Returns information about the workshop participant.

Return values
stringHTML code

◆ helper_remove_allocation_icon()

workshopallocation_manual_renderer::helper_remove_allocation_icon ( $link)
protected

Generates an icon link to remove the allocation.

Parameters
moodle_url$linkto the action
Return values
htmlcode to be displayed

◆ helper_reviewees_of_participant()

workshopallocation_manual_renderer::helper_reviewees_of_participant ( stdclass $allocation,
array $userinfo,
array $authors,
$selfassessment )
protected

Returns information about the current reviewees of the given participant and a selector do add new one.

Return values
stringhtml code

◆ helper_reviewers_of_participant()

workshopallocation_manual_renderer::helper_reviewers_of_participant ( stdclass $allocation,
array $userinfo,
array $reviewers,
$selfassessment )
protected

Returns information about the current reviewers of the given participant and a selector do add new one.

Return values
stringhtml code

◆ helper_sortable_heading()

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

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' )
protectedinherited

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)
protectedinherited

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

◆ initials_bars()

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

Render the initials bars for workshop.

Parameters
workshop$workshopthe current workshop of initial bars.
moodle_url$urlbase URL object.
Return values
stringHTML.

◆ moodleform()

static mod_workshop_renderer::moodleform ( moodleform $mform)
staticprotectedinherited

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)
protectedinherited

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)
inherited

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 core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_action_buttons()

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

Generates the action buttons.

Parameters
workshop$workshopThe current workshop.
workshop_user_plan$userplanAn individual workshop plan for the user.
Return values
stringHTML to display.

◆ render_allocation_menu()

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

Renders the tertiary nav for the allocation pages.

Parameters
mod_workshop\output\actionbar$actionbar
Return values
bool|stringthe rendered output

◆ 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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

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)
protectedinherited

Renders workshop message.

Parameters
workshop_message$messageto display
Return values
stringhtml code

◆ render_workshop_submission()

mod_workshop_renderer::render_workshop_submission ( workshop_submission $submission)
protectedinherited

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)
protectedinherited

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)
protectedinherited

Renders the user plannner tool.

Parameters
workshop_user_plan$planprepared for the user
Return values
stringhtml code to be displayed

◆ render_workshopallocation_manual_allocations()

workshopallocation_manual_renderer::render_workshopallocation_manual_allocations ( workshopallocation_manual_allocations $data)
protected

Display the table of all current allocations and widgets to modify them.

Parameters
workshopallocation_manual_allocations$datato be displayed
Return values
stringhtml code

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

◆ view_page()

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

Generates the view page.

Parameters
workshop$workshopThe current workshop.
workshop_user_plan$userplanAn individual workshop plan for the user.
string$currentphasetitleThe current phase title.
int$pageThe current page (for the pagination).
string$sortbyLastname|firstname|submissiontitle|submissiongrade|gradinggrade.
string$sorthowASC|DESC.
Return values
stringHTML to display.

◆ view_submissions_report()

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

Generates the submission report.

Parameters
workshop$workshopThe current workshop.
workshop_user_plan$userplanAn individual workshop plan for the user.
int$pageThe current page (for the pagination).
string$sortbyLastname|firstname|submissiontitle|submissiongrade|gradinggrade.
string$sorthowASC|DESC.
Return values
stringHTML to display.

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: