Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
mod_forum\local\exporters\posts Class Reference

Posts exporter class. More...

Inheritance diagram for mod_forum\local\exporters\posts:

Public Member Functions

 __construct (array $posts, array $authorsbyid=[], array $authorcontextids=[], array $attachmentsbypostid=[], array $groupsbyauthorid=[], array $tagsbypostid=[], array $ratingbypostid=[], array $related=[], array $inlineattachmentsbypostid=[])
 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

Posts exporter class.

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

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\exporters\posts::__construct ( array $posts,
array $authorsbyid = [],
array $authorcontextids = [],
array $attachmentsbypostid = [],
array $groupsbyauthorid = [],
array $tagsbypostid = [],
array $ratingbypostid = [],
array $related = [],
array $inlineattachmentsbypostid = [] )

Constructor.

Parameters
post_entity[]$postsList of posts to export
author_entity[]$authorsbyidList of authors for the posts indexed by author id
int[]$authorcontextidsList of authors context ids indexed by author id
array$attachmentsbypostidList of attachments indexed by post id
array$groupsbyauthoridList of author's groups indexed by author id
array$tagsbypostidList of tags indexed by post id
array$ratingbypostidList of ratings indexed by post id
array$relatedThe related objects for exporting
array$inlineattachmentsbypostidList of inline attachments indexed by post id

Member Function Documentation

◆ define_other_properties()

static mod_forum\local\exporters\posts::define_other_properties ( )
staticprotected

Return the list of additional properties.

Return values
array

◆ define_related()

static mod_forum\local\exporters\posts::define_related ( )
staticprotected

Returns a list of objects that are related.

Return values
array

◆ get_other_values()

mod_forum\local\exporters\posts::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: