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

Post exporter class. More...

Inheritance diagram for mod_forum\local\exporters\post:

Public Member Functions

 __construct (post_entity $post, array $related=[])
 Constructor.
 

Protected Member Functions

 get_format_parameters_for_message ()
 This method returns the parameters for the post's message to use with the function core_external\util\format_text().
 
 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

Post exporter class.

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

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\exporters\post::__construct ( post_entity $post,
array $related = [] )

Constructor.

Parameters
post_entity$postThe post to export
array$relatedList of related data

Member Function Documentation

◆ define_other_properties()

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

Return the list of additional properties.

Return values
array

◆ define_related()

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

Returns a list of objects that are related.

Return values
array

◆ get_format_parameters_for_message()

mod_forum\local\exporters\post::get_format_parameters_for_message ( )
protected

This method returns the parameters for the post's message to use with the function core_external\util\format_text().

Return values
array

◆ get_other_values()

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