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.

Constructor & Destructor Documentation

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[]	$posts	List of posts to export
author_entity[]	$authorsbyid	List of authors for the posts indexed by author id
int[]	$authorcontextids	List of authors context ids indexed by author id
array	$attachmentsbypostid	List of attachments indexed by post id
array	$groupsbyauthorid	List of author's groups indexed by author id
array	$tagsbypostid	List of tags indexed by post id
array	$ratingbypostid	List of ratings indexed by post id
array	$related	The related objects for exporting
array	$inlineattachmentsbypostid	List of inline attachments indexed by post id

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

staticprotected

Return the list of additional properties.

Return values

array

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

staticprotected

Returns a list of objects that are related.

Return values

array

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