Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
mod_forum_renderer Class Reference

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

Inheritance diagram for mod_forum_renderer:
plugin_renderer_base renderer_base mod_forum\output\email\renderer mod_forum\output\email\renderer_textemail mod_forum\output\emaildigestbasic\renderer mod_forum\output\emaildigestfull\renderer mod_forum\output\emaildigestbasic\renderer_textemail mod_forum\output\emaildigestfull\renderer_textemail

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.
 
 forum_post_template ()
 The template name for this renderer.
 
 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.
 
 neighbouring_discussion_navigation ($prev, $next)
 Returns the navigation to the previous and next discussion.
 
 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_activity_actionbar (\mod_forum\output\forum_actionbar $actionbar)
 Render the view action area.
 
 render_big_search_form (\mod_forum\output\big_search_form $form)
 Render big search form.
 
 render_digest_options ($forum, $value)
 Create the inplace_editable used to select forum digest options.
 
 render_forum_post_email (\mod_forum\output\forum_post_email $post)
 Display a forum post in the relevant context.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_quick_search_form (\mod_forum\output\quick_search_form $form)
 Render quick search form.
 
 should_display_main_logo ()
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 
 subscribed_users (user_selector_base $existingusers)
 This is used to display a control containing all of the subscribed users so that it can be searched.
 
 subscriber_overview ($users, $forum, $course)
 This function generates HTML to display a subscriber overview, primarily used on the subscribers page if editing was turned off.
 
 subscriber_selection_form (user_selector_base $existinguc, user_selector_base $potentialuc)
 This method is used to generate HTML for a subscriber selection form that uses two user_selector controls.
 
 subscription_actionbar (\mod_forum\output\subscription_actionbar $subscriptionactionbar)
 Render the subscription action area.
 
 timed_discussion_tooltip ($discussion, $visiblenow)
 Generate the HTML for an icon to be displayed beside the subject of a timed discussion.
 

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.
 

Detailed Description

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

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

Member Function Documentation

◆ forum_post_template()

◆ neighbouring_discussion_navigation()

mod_forum_renderer::neighbouring_discussion_navigation ( $prev,
$next )

Returns the navigation to the previous and next discussion.

Parameters
mixed$prevPrevious discussion record, or false.
mixed$nextNext discussion record, or false.
Return values
stringThe output.

◆ render_activity_actionbar()

mod_forum_renderer::render_activity_actionbar ( \mod_forum\output\forum_actionbar $actionbar)

Render the view action area.

Parameters
mod_forum\output\forum_actionbar$actionbarforum_actionbar object.
Return values
stringrendered HTML string

◆ render_big_search_form()

mod_forum_renderer::render_big_search_form ( \mod_forum\output\big_search_form $form)

Render big search form.

Parameters
mod_forum\output\big_search_form$formThe renderable.
Return values
string

◆ render_digest_options()

mod_forum_renderer::render_digest_options ( $forum,
$value )

Create the inplace_editable used to select forum digest options.

Parameters
stdClass$forumThe forum to create the editable for.
int$valueThe current value for this user
Return values
inplace_editable

◆ render_forum_post_email()

mod_forum_renderer::render_forum_post_email ( \mod_forum\output\forum_post_email $post)

Display a forum post in the relevant context.

Parameters
mod_forum\output\forum_post$postThe post to display.
Return values
string

◆ render_quick_search_form()

mod_forum_renderer::render_quick_search_form ( \mod_forum\output\quick_search_form $form)

Render quick search form.

Parameters
mod_forum\output\quick_search_form$formThe renderable.
Return values
stringrendered HTML string from the template.

◆ subscribed_users()

mod_forum_renderer::subscribed_users ( user_selector_base $existingusers)

This is used to display a control containing all of the subscribed users so that it can be searched.

Parameters
user_selector_base$existingusers
Return values
string

◆ subscriber_overview()

mod_forum_renderer::subscriber_overview ( $users,
$forum,
$course )

This function generates HTML to display a subscriber overview, primarily used on the subscribers page if editing was turned off.

Parameters
array$users
object$forum
object$course
Return values
string

◆ subscriber_selection_form()

mod_forum_renderer::subscriber_selection_form ( user_selector_base $existinguc,
user_selector_base $potentialuc )

This method is used to generate HTML for a subscriber selection form that uses two user_selector controls.

Parameters
user_selector_base$existinguc
user_selector_base$potentialuc
Return values
string

◆ subscription_actionbar()

mod_forum_renderer::subscription_actionbar ( \mod_forum\output\subscription_actionbar $subscriptionactionbar)

Render the subscription action area.

Parameters
mod_forum\output\subscription_actionbar$subscriptionactionbarsubscription_actionbar object.
Return values
bool|stringrendered HTML string.

◆ timed_discussion_tooltip()

mod_forum_renderer::timed_discussion_tooltip ( $discussion,
$visiblenow )

Generate the HTML for an icon to be displayed beside the subject of a timed discussion.

Parameters
object$discussion
bool$visiblenowIndicicates that the discussion is currently visible to all users.
Return values
string

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