Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | List of all members
mod_forum\local\entities\discussion_summary Class Reference

Discussion summary class. More...

Public Member Functions

 __construct (discussion_entity $discussion, post_entity $firstpost, author_entity $firstpostauthor, author_entity $latestpostauthor)
 Constructor. More...
 
 get_discussion ()
 Get the discussion entity. More...
 
 get_first_post ()
 Get the post entity for the first post. More...
 
 get_first_post_author ()
 Get the author entity for the first post. More...
 
 get_latest_post_author ()
 Get the author entity for the last post. More...
 

Detailed Description

Discussion summary class.

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

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\entities\discussion_summary::__construct ( discussion_entity  $discussion,
post_entity  $firstpost,
author_entity  $firstpostauthor,
author_entity  $latestpostauthor 
)

Constructor.

Parameters
discussion_entity$discussionThe discussion being summarised
post_entity$firstpostFirst post in the discussion
author_entity$firstpostauthorAuthor of the first post in the discussion
author_entity$latestpostauthorAuthor of the last post in the discussion

Member Function Documentation

◆ get_discussion()

mod_forum\local\entities\discussion_summary::get_discussion ( )

Get the discussion entity.

Return values
discussion_entity

◆ get_first_post()

mod_forum\local\entities\discussion_summary::get_first_post ( )

Get the post entity for the first post.

Return values
post_entity

◆ get_first_post_author()

mod_forum\local\entities\discussion_summary::get_first_post_author ( )

Get the author entity for the first post.

Return values
author_entity

◆ get_latest_post_author()

mod_forum\local\entities\discussion_summary::get_latest_post_author ( )

Get the author entity for the last post.

Return values
author_entity

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