Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Forum Exporter.

Copyright: 2019 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 194 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

forum:: (5 methods):
  __construct()
  define_other_properties()
  get_other_values()
  define_related()
  get_forum_record()


Class: forum  - X-Ref

Forum class.

__construct(forum_entity $forum, $related = [])   X-Ref
Constructor for the forum exporter.

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

define_other_properties()   X-Ref
Return the list of additional properties.

return: array

get_other_values(renderer_base $output)   X-Ref
Get the additional values to inject while exporting.

param: renderer_base $output The renderer.
return: array Keys are the property names, values are their values.

define_related()   X-Ref
Returns a list of objects that are related.

return: array

get_forum_record()   X-Ref
Get the legacy forum record for this forum.

return: stdClass