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:

Public Member Functions
	forum_post_template ()
	The template name for this renderer.
	neighbouring_discussion_navigation ($prev, $next)
	Returns the navigation to the previous and next discussion.
	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_quick_search_form (\mod_forum\output\quick_search_form $form)
	Render quick search form.
	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.

Detailed Description

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

Copyright

2009 Sam Hemelryk

License

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

Member Function Documentation

forum_post_template()

mod_forum_renderer::forum_post_template

(

)

The template name for this renderer.

Return values

string

Reimplemented in mod_forum\output\email\renderer, mod_forum\output\email\renderer_textemail, mod_forum\output\emaildigestbasic\renderer, mod_forum\output\emaildigestbasic\renderer_textemail, mod_forum\output\emaildigestfull\renderer, and mod_forum\output\emaildigestfull\renderer_textemail.

neighbouring_discussion_navigation()

mod_forum_renderer::neighbouring_discussion_navigation	(		$prev,
			$next )

Returns the navigation to the previous and next discussion.

Parameters

mixed	$prev	Previous discussion record, or false.
mixed	$next	Next discussion record, or false.

Return values

string

The 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

$actionbar

forum_actionbar object.

Return values

string

rendered 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

$form

The 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	$forum	The forum to create the editable for.
int	$value	The 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

$post

The 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

$form

The renderable.

Return values

string

rendered 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

$subscriptionactionbar

subscription_actionbar object.

Return values

bool|string

rendered 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	$visiblenow	Indicicates that the discussion is currently visible to all users.

Return values

string

---

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

• mod/forum/renderer.php