mod_forum\local\exporters\forum Class Reference

Forum class. More...

Inheritance diagram for mod_forum\local\exporters\forum:

Public Member Functions
	__construct (forum_entity $forum, $related=[])
	Constructor for the forum exporter.

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

Forum class.

Copyright

2019 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Constructor & Destructor Documentation

__construct()

mod_forum\local\exporters\forum::__construct	(	forum_entity	$forum,
			$related = [] )

Constructor for the forum exporter.

Parameters

forum_entity	$forum	The forum being displayed
array	$related	The related objects

Member Function Documentation

define_other_properties()

static mod_forum\local\exporters\forum::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

define_related()

static mod_forum\local\exporters\forum::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

get_other_values()

mod_forum\local\exporters\forum::get_other_values ( renderer_base $output )

protected

Get the additional values to inject while exporting.

Parameters

renderer_base

$output

The renderer.

Return values

array

Keys are the property names, values are their values.

---

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

• mod/forum/classes/local/exporters/forum.php