Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/mod/forum/ -> renderer.php (source)

[Source view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402]

This file contains a custom renderer class used by the forum module.

Copyright: 2009 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 286 lines (12 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

mod_forum_renderer:: (12 methods):
  neighbouring_discussion_navigation()
  subscriber_selection_form()
  subscriber_overview()
  subscribed_users()
  timed_discussion_tooltip()
  render_forum_post_email()
  forum_post_template()
  render_digest_options()
  render_quick_search_form()
  render_activity_actionbar()
  subscription_actionbar()
  render_big_search_form()


Class: mod_forum_renderer  - X-Ref

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

neighbouring_discussion_navigation($prev, $next)   X-Ref
Returns the navigation to the previous and next discussion.

param: mixed $prev Previous discussion record, or false.
param: mixed $next Next discussion record, or false.
return: string The output.

subscriber_selection_form(user_selector_base $existinguc, user_selector_base $potentialuc)   X-Ref
This method is used to generate HTML for a subscriber selection form that
uses two user_selector controls

param: user_selector_base $existinguc
param: user_selector_base $potentialuc
return: string

subscriber_overview($users, $forum , $course)   X-Ref
This function generates HTML to display a subscriber overview, primarily used on
the subscribers page if editing was turned off

param: array $users
param: object $forum
param: object $course
return: string

subscribed_users(user_selector_base $existingusers)   X-Ref
This is used to display a control containing all of the subscribed users so that
it can be searched

param: user_selector_base $existingusers
return: string

timed_discussion_tooltip($discussion, $visiblenow)   X-Ref
Generate the HTML for an icon to be displayed beside the subject of a timed discussion.

param: object $discussion
param: bool $visiblenow Indicicates that the discussion is currently
return: string

render_forum_post_email(\mod_forum\output\forum_post_email $post)   X-Ref
Display a forum post in the relevant context.

param: \mod_forum\output\forum_post $post The post to display.
return: string

forum_post_template()   X-Ref
The template name for this renderer.

return: string

render_digest_options($forum, $value)   X-Ref
Create the inplace_editable used to select forum digest options.

param: stdClass    $forum  The forum to create the editable for.
param: int         $value  The current value for this user
return: inplace_editable

render_quick_search_form(\mod_forum\output\quick_search_form $form)   X-Ref
Render quick search form.

param: \mod_forum\output\quick_search_form $form The renderable.
return: string rendered HTML string from the template.

render_activity_actionbar(\mod_forum\output\forum_actionbar $actionbar)   X-Ref
Render the view action area.

param: \mod_forum\output\forum_actionbar $actionbar forum_actionbar object.
return: string rendered HTML string

subscription_actionbar(\mod_forum\output\subscription_actionbar $subscriptionactionbar)   X-Ref
Render the subscription action area.

param: \mod_forum\output\subscription_actionbar $subscriptionactionbar subscription_actionbar object.
return: bool|string rendered HTML string.

render_big_search_form(\mod_forum\output\big_search_form $form)   X-Ref
Render big search form.

param: \mod_forum\output\big_search_form $form The renderable.
return: string