Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
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.

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$summaryThe discussion summary information
stdClass[]$groupsbyidThe group information for each author
stdClass[]$groupsbyauthoridThe group information for each author
int$replycountThe number of replies to the discussion
int$unreadcountnumber of unread posts if the user is tracking these
int$latestpostidThe latest post id in the discussion
int | null$firstpostauthorcontextidThe context id for the author of the first post
int | null$latestpostauthorcontextidThe context id for the author of the latest post
array$relatedThe 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$outputThe renderer.
Return values
arrayKeys are the property names, values are their values.

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