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.
/lib/classes/content/export/exporters/ -> component_exporter.php (source)

[Source view]

Content API Export definition.

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

Defines 1 class

component_exporter:: (5 methods):
  __construct()
  get_context()
  get_component()
  get_archive()
  get_classname_for_component()


Class: component_exporter  - X-Ref

A class to help define, describe, and export content in a specific context.

__construct(context $context, string $component, stdClass $user, zipwriter $archive)   X-Ref
Constructor for a new exporter.

param: context $context The context to export
param: string $component The component that this instance relates to
param: stdClass $user The user to be exported
param: zipwriter $archive

get_context()   X-Ref
Get the context being exported.

return: context

get_component()   X-Ref
Get the component name.

return: string

get_archive()   X-Ref
Get the archive used for export.

return: zipwriter

get_classname_for_component(string $component)   X-Ref
Get the name of the exporter for the specified component.

param: string $component The component to fetch a classname for
return: string The classname for the component