mod_forum\local\exporters\discussion_summary Class Reference

Discussion summary exporter class. More...

Inheritance diagram for mod_forum\local\exporters\discussion_summary:

Public Member Functions
	__construct (discussion_summary_entity $summary, array $groupsbyid, array $groupsbyauthorid, int $replycount, int $unreadcount, int $latestpostid, ?int $firstpostauthorcontextid, ?int $latestpostauthorcontextid, array $related=[])
	Constructor.

Protected Member Functions
	get_other_values (renderer_base $output)
	Get the additional values to inject while exporting.

Static Protected Member Functions
static	define_other_properties ()
	Return the list of additional properties.
static	define_related ()
	Returns a list of objects that are related.

Detailed Description

Discussion summary exporter class.

Copyright

2019 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

Constructor & Destructor Documentation

__construct()

mod_forum\local\exporters\discussion_summary::__construct	(	discussion_summary_entity	$summary,
		array	$groupsbyid,
		array	$groupsbyauthorid,
		int	$replycount,
		int	$unreadcount,
		int	$latestpostid,
		?int	$firstpostauthorcontextid,
		?int	$latestpostauthorcontextid,
		array	$related = [] )

Constructor.

Parameters

discussion_summary_entity	$summary	The discussion summary information
stdClass[]	$groupsbyid	The group information for each author
stdClass[]	$groupsbyauthorid	The group information for each author
int	$replycount	The number of replies to the discussion
int	$unreadcount	number of unread posts if the user is tracking these
int	$latestpostid	The latest post id in the discussion
int | null	$firstpostauthorcontextid	The context id for the author of the first post
int | null	$latestpostauthorcontextid	The context id for the author of the latest post
array	$related	The related objects

Member Function Documentation

define_other_properties()

static mod_forum\local\exporters\discussion_summary::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

define_related()

static mod_forum\local\exporters\discussion_summary::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

get_other_values()

mod_forum\local\exporters\discussion_summary::get_other_values ( renderer_base $output )

protected

Get the additional values to inject while exporting.

Parameters

renderer_base

$output

The renderer.

Return values

array

Keys are the property names, values are their values.

---

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

• mod/forum/classes/local/exporters/discussion_summary.php