mod_forum\local\exporters\discussion_summaries Class Reference

Discussion summaries exporter. More...

Inheritance diagram for mod_forum\local\exporters\discussion_summaries:

Public Member Functions
	__construct (array $discussions, array $groupsbyid, array $groupsbyauthorid, array $discussionreplycount, array $discussionunreadcount, array $latestpostids, array $postauthorcontextids, 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 summaries exporter.

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_summaries::__construct	(	array	$discussions,
		array	$groupsbyid,
		array	$groupsbyauthorid,
		array	$discussionreplycount,
		array	$discussionunreadcount,
		array	$latestpostids,
		array	$postauthorcontextids,
		array	$related = [] )

Constructor.

Parameters

discussion_summary_entity[]	$discussion	The list of discussion summaries to export
stdClass[]	$groupsbyid	The group information for each author
stdClass[]	$groupsbyauthorid	The group information for each author
int[]	$discussionreplycount	Discussion reply counts indexed by dicussion id
int[]	$discussionunreadcount	Discussion unread counts indexed by dicussion id
int[]	$latestpostids	List of latest post ids indexed by discussion id
int[]	$postauthorcontextids	The context ids for the first and latest post authors (indexed by author id)
array	$related	The related

Member Function Documentation

define_other_properties()

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

staticprotected

Return the list of additional properties.

Return values

array

define_related()

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

staticprotected

Returns a list of objects that are related.

Return values

array

get_other_values()

mod_forum\local\exporters\discussion_summaries::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_summaries.php