Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_forum\output\emaildigestbasic\renderer_textemail Class Reference

Forum post renderable. More...

Inheritance diagram for mod_forum\output\emaildigestbasic\renderer_textemail:
mod_forum\output\email\renderer_textemail mod_forum\output\email\renderer mod_forum_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.
 
 format_message_attachments ($cm, $post)
 The plaintext version of the attachments list.
 
 format_message_text ($cm, $post)
 The plaintext version of the e-mail message.
 
 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.
 
 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 ($headinglevel=1)
 Whether we should display the 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

Forum post renderable.

Since
Moodle 3.0
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

◆ format_message_attachments()

mod_forum\output\email\renderer_textemail::format_message_attachments ( $cm,
$post )
inherited

The plaintext version of the attachments list.

Parameters
stdClass$cm
stdClass$post
Return values
string

Reimplemented from mod_forum\output\email\renderer.

◆ format_message_text()

mod_forum\output\emaildigestbasic\renderer_textemail::format_message_text ( $cm,
$post )

The plaintext version of the e-mail message.

Parameters
stdClass$cm
stdClass$post
Return values
string

Reimplemented from mod_forum\output\email\renderer_textemail.

◆ forum_post_template()

mod_forum\output\emaildigestbasic\renderer_textemail::forum_post_template ( )

The template name for this renderer.

Return values
string

Reimplemented from mod_forum\output\email\renderer_textemail.

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

◆ 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

◆ neighbouring_discussion_navigation()

mod_forum_renderer::neighbouring_discussion_navigation ( $prev,
$next )
inherited

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.

◆ 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_activity_actionbar()

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

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

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

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

Display a forum post in the relevant context.

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

◆ 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_quick_search_form()

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

Render quick search form.

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

◆ 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

◆ subscribed_users()

mod_forum_renderer::subscribed_users ( user_selector_base $existingusers)
inherited

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

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

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

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

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

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: