Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Discussion summary exporter class.

Copyright: 2019 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 198 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

discussion_summary:: (4 methods):
  __construct()
  define_other_properties()
  get_other_values()
  define_related()


Class: discussion_summary  - X-Ref

Discussion summary exporter class.

__construct(discussion_summary_entity $summary,array $groupsbyid,array $groupsbyauthorid,int $replycount,int $unreadcount,int $latestpostid,?int $firstpostauthorcontextid,?int $latestpostauthorcontextid,array $related = [])   X-Ref
Constructor.

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

define_other_properties()   X-Ref
Return the list of additional properties.

return: array

get_other_values(renderer_base $output)   X-Ref
Get the additional values to inject while exporting.

param: renderer_base $output The renderer.
return: array Keys are the property names, values are their values.

define_related()   X-Ref
Returns a list of objects that are related.

return: array