mod_forum\output\forum_post_email Class Reference

Forum post renderable for use in e-mail. More...

Inheritance diagram for mod_forum\output\forum_post_email:

Public Member Functions
	__set ($key, $value)
	Magically sets a property against this object.
	export_for_template (\renderer_base $renderer, $plaintext=false)
	Export this data so it can be used as the context for a mustache template.
	get_author_fullname ()
	The fullname of the post author.
	get_author_picture (\renderer_base $renderer)
	The HTML for the author's user picture.
	get_authorlink ()
	Get the link to the author's profile page.
	get_coursefullname ()
	The full name of the course that the forum is in.
	get_courseidnumber ()
	ID number of the course that the forum is in.
	get_courselink ()
	Get the link to the course.
	get_coursename ()
	The name of the course that the forum is in.
	get_discussionlink ()
	Get the link to the current discussion.
	get_discussionname ()
	The name of the current discussion.
	get_forumindexlink ()
	Get the link to the forum index for this course.
	get_forumname ()
	The name of the forum.
	get_forumviewlink ()
	Get the link to the view page for this forum.
	get_group_picture (\renderer_base $renderer)
	The HTML for a group picture.
	get_is_firstpost ()
	Whether this is the first post.
	get_parentpostlink ()
	Get the link to the parent post.
	get_permalink ()
	Get the link to the current post, including post anchor.
	get_postanchor ()
	The plaintext anchor id for the current post.
	get_postdate ()
	The date of the post, formatted according to the postto user's preferences.
	get_replylink ()
	Get the link to reply to the current post.
	get_showdiscussionname ()
	Whether to show the discussion name.
	get_subject ()
	The formatted subject for the current post.
	get_unsubscribediscussionlink ()
	Get the link to unsubscribe from the discussion.
	get_unsubscribeforumlink ()
	Get the link to unsubscribe from the forum.

Protected Member Functions
	_get_discussionlink ()
	Get the link to the current discussion.
	export_for_template_html (\mod_forum_renderer $renderer)
	Export this data so it can be used as the context for a mustache template.
	export_for_template_shared (\mod_forum_renderer $renderer)
	Export this data so it can be used as the context for a mustache template.
	export_for_template_text (\mod_forum_renderer $renderer)
	Export this data so it can be used as the context for a mustache template.
	get_postto ()
	The recipient of the post.

Protected Attributes
object	$author = null
	The user that wrote the post.
boolean	$canreply = false
	Whether the user can reply to this post.
object	$cm = null
	The course module for the forum.
object	$course = null
	The course that the forum post is in.
object	$discussion = null
	The discussion that the forum post is in.
object	$forum = null
	The forum that the post is in.
object	$post = null
	The forum post being displayed.
stdClass	$userfrom
	user record.
object	$userto = null
	The user that is reading the post.
boolean	$viewfullnames = false
	Whether to override forum display when displaying usernames.
array	$writablekeys
	An associative array indicating which keys on this object should be writeable.

Detailed Description

Forum post renderable for use in e-mail.

Copyright

2015 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Member Function Documentation

__set()

mod_forum\output\forum_post::__set ( $key, $value )

inherited

Magically sets a property against this object.

Parameters

string	$key
mixed	$value

_get_discussionlink()

mod_forum\output\forum_post::_get_discussionlink ( )

protectedinherited

Get the link to the current discussion.

Return values

string

export_for_template()

mod_forum\output\forum_post::export_for_template ( \renderer_base $renderer, $plaintext = false )

inherited

Export this data so it can be used as the context for a mustache template.

Parameters

mod_forum_renderer	$renderer	The render to be used for formatting the message and attachments
bool	$plaintext	Whethe the target is a plaintext target

Return values

array

Data ready for use in a mustache template

export_for_template_html()

mod_forum\output\forum_post::export_for_template_html ( \mod_forum_renderer $renderer )

protectedinherited

Export this data so it can be used as the context for a mustache template.

Parameters

mod_forum_renderer

$renderer

The render to be used for formatting the message and attachments

Return values

array

Data ready for use in a mustache template

export_for_template_shared()

mod_forum\output\forum_post::export_for_template_shared ( \mod_forum_renderer $renderer )

protectedinherited

Export this data so it can be used as the context for a mustache template.

Parameters

mod_forum_renderer

$renderer

The render to be used for formatting the message and attachments

Return values

stdClass

Data ready for use in a mustache template

export_for_template_text()

mod_forum\output\forum_post::export_for_template_text ( \mod_forum_renderer $renderer )

protectedinherited

Export this data so it can be used as the context for a mustache template.

Parameters

mod_forum_renderer

$renderer

The render to be used for formatting the message and attachments

Return values

array

Data ready for use in a mustache template

get_author_fullname()

mod_forum\output\forum_post::get_author_fullname ( )

inherited

The fullname of the post author.

Return values

string

get_author_picture()

mod_forum\output\forum_post::get_author_picture ( \renderer_base $renderer )

inherited

The HTML for the author's user picture.

Parameters

renderer_base

$renderer

Return values

string

get_authorlink()

mod_forum\output\forum_post::get_authorlink ( )

inherited

Get the link to the author's profile page.

Return values

string

get_coursefullname()

mod_forum\output\forum_post::get_coursefullname ( )

inherited

The full name of the course that the forum is in.

Return values

string

get_courseidnumber()

mod_forum\output\forum_post::get_courseidnumber ( )

inherited

ID number of the course that the forum is in.

Return values

string

get_courselink()

mod_forum\output\forum_post::get_courselink ( )

inherited

Get the link to the course.

Return values

string

get_coursename()

mod_forum\output\forum_post::get_coursename ( )

inherited

The name of the course that the forum is in.

Return values

string

get_discussionlink()

mod_forum\output\forum_post::get_discussionlink ( )

inherited

Get the link to the current discussion.

Return values

string

get_discussionname()

mod_forum\output\forum_post::get_discussionname ( )

inherited

The name of the current discussion.

Return values

string

get_forumindexlink()

mod_forum\output\forum_post::get_forumindexlink ( )

inherited

Get the link to the forum index for this course.

Return values

string

get_forumname()

mod_forum\output\forum_post::get_forumname ( )

inherited

The name of the forum.

Return values

string

get_forumviewlink()

mod_forum\output\forum_post::get_forumviewlink ( )

inherited

Get the link to the view page for this forum.

Return values

string

get_group_picture()

mod_forum\output\forum_post::get_group_picture ( \renderer_base $renderer )

inherited

The HTML for a group picture.

Parameters

renderer_base

$renderer

Return values

string

get_is_firstpost()

mod_forum\output\forum_post::get_is_firstpost ( )

inherited

Whether this is the first post.

Return values

boolean

get_parentpostlink()

mod_forum\output\forum_post::get_parentpostlink ( )

inherited

Get the link to the parent post.

Return values

string

get_permalink()

mod_forum\output\forum_post::get_permalink ( )

inherited

Get the link to the current post, including post anchor.

Return values

string

get_postanchor()

mod_forum\output\forum_post::get_postanchor ( )

inherited

The plaintext anchor id for the current post.

Return values

string

get_postdate()

mod_forum\output\forum_post::get_postdate ( )

inherited

The date of the post, formatted according to the postto user's preferences.

Return values

string

get_postto()

mod_forum\output\forum_post::get_postto ( )

protectedinherited

The recipient of the post.

Return values

string

get_replylink()

mod_forum\output\forum_post::get_replylink ( )

inherited

Get the link to reply to the current post.

Return values

string

get_showdiscussionname()

mod_forum\output\forum_post::get_showdiscussionname ( )

inherited

Whether to show the discussion name.

If the forum name matches the discussion name, the discussion name is not typically displayed.

Return values

boolean

get_subject()

mod_forum\output\forum_post::get_subject ( )

inherited

The formatted subject for the current post.

Return values

string

get_unsubscribediscussionlink()

mod_forum\output\forum_post::get_unsubscribediscussionlink ( )

inherited

Get the link to unsubscribe from the discussion.

Return values

string

get_unsubscribeforumlink()

mod_forum\output\forum_post::get_unsubscribeforumlink ( )

inherited

Get the link to unsubscribe from the forum.

Return values

string

Member Data Documentation

$author

object mod_forum\output\forum_post::$author = null

protectedinherited

The user that wrote the post.

$author

$canreply

boolean mod_forum\output\forum_post::$canreply = false

protectedinherited

Whether the user can reply to this post.

$canreply

$cm

object mod_forum\output\forum_post::$cm = null

protectedinherited

The course module for the forum.

$cm

$course

object mod_forum\output\forum_post::$course = null

protectedinherited

The course that the forum post is in.

$course

$discussion

object mod_forum\output\forum_post::$discussion = null

protectedinherited

The discussion that the forum post is in.

$discussion

$forum

object mod_forum\output\forum_post::$forum = null

protectedinherited

The forum that the post is in.

$forum

$post

object mod_forum\output\forum_post::$post = null

protectedinherited

The forum post being displayed.

$post

$userto

object mod_forum\output\forum_post::$userto = null

protectedinherited

The user that is reading the post.

$userto

$viewfullnames

boolean mod_forum\output\forum_post::$viewfullnames = false

protectedinherited

Whether to override forum display when displaying usernames.

$viewfullnames

$writablekeys

array mod_forum\output\forum_post::$writablekeys

protectedinherited

Initial value:

= array(
        'viewfullnames'    => true,
    )

An associative array indicating which keys on this object should be writeable.

$writablekeys

---

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

• mod/forum/classes/output/forum_post_email.php