Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 310 and 311] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

Author exporter.

Copyright: 2019 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 222 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

author:: (4 methods):
  __construct()
  define_other_properties()
  get_other_values()
  define_related()


Class: author  - X-Ref

Author exporter.

__construct(author_entity $author,?int $authorcontextid,array $authorgroups = [],bool $canview = true,array $related = [])   X-Ref
Constructor.

param: author_entity $author The author entity to export
param: int|null $authorcontextid The context id for the author entity to export (null if the user doesn't have one)
param: stdClass[] $authorgroups The list of groups that the author belongs to
param: bool $canview Can the requesting user view this author or should it be anonymised?
param: array $related The related data for the export.

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