Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
mod_forum\local\exporters\author Class Reference

Author exporter. More...

Inheritance diagram for mod_forum\local\exporters\author:

Public Member Functions

 __construct (author_entity $author, ?int $authorcontextid, array $authorgroups=[], bool $canview=true, 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

Author exporter.

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

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\exporters\author::__construct ( author_entity $author,
?int $authorcontextid,
array $authorgroups = [],
bool $canview = true,
array $related = [] )

Constructor.

Parameters
author_entity$authorThe author entity to export
int | null$authorcontextidThe context id for the author entity to export (null if the user doesn't have one)
stdClass[]$authorgroupsThe list of groups that the author belongs to
bool$canviewCan the requesting user view this author or should it be anonymised?
array$relatedThe related data for the export.

Member Function Documentation

◆ define_other_properties()

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

Return the list of additional properties.

Return values
array

◆ define_related()

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

Returns a list of objects that are related.

Return values
array

◆ get_other_values()

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