core\content\export\exporters\abstract_mod_exporter Class Reference

Activity module exporter for the content API. More...

Inheritance diagram for core\content\export\exporters\abstract_mod_exporter:

Public Member Functions
	__construct ()
	Constructor for the general activity exporter.
	get_archive ()
	Get the archive used for export.
	get_component ()
	Get the component name.
	get_context ()
	Get the context being exported.
	get_exportables (bool $includeuserdata=false)
	Get the exportable items for the user in the specified context.

Static Public Member Functions
static	get_classname_for_component (string $component)
	Get the name of the exporter for the specified component.

Protected Member Functions
	get_modname ()
	Get the modname for the activity.

Protected Attributes
zipwriter	$archive
	A reference to the zipwriter.
cm_info	$cm
	The activity information for this course module.
string	$component = null
	The component that this instance belongs to.
context	$context = null
	The context to be exported.
stdClass	$user
	The user being exported.

Detailed Description

Activity module exporter for the content API.

Copyright

2020 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

Member Function Documentation

get_archive()

core\content\export\exporters\component_exporter::get_archive ( )

inherited

Get the archive used for export.

Return values

zipwriter

get_classname_for_component()

static core\content\export\exporters\component_exporter::get_classname_for_component ( string $component )

staticinherited

Get the name of the exporter for the specified component.

Parameters

string

$component

The component to fetch a classname for

Return values

string

The classname for the component

get_component()

core\content\export\exporters\component_exporter::get_component ( )

inherited

Get the component name.

Return values

string

get_context()

core\content\export\exporters\component_exporter::get_context ( )

inherited

Get the context being exported.

Return values

context

get_exportables()

core\content\export\exporters\abstract_mod_exporter::get_exportables ( bool $includeuserdata = false )

abstract

Get the exportable items for the user in the specified context.

For activities which allow users to submit their own content which is not visible to all users, for example graded activities, the caller can request that this be either included, or excluded.

Parameters

bool

$includeuserdata

Whether to include user data, in addition to shared content.

Return values

exportable_item[]

Reimplemented in mod_folder\content\exporter, mod_page\content\exporter, and mod_resource\content\exporter.

get_modname()

core\content\export\exporters\abstract_mod_exporter::get_modname ( )

protected

Get the modname for the activity.

Return values

string

---

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

• lib/classes/content/export/exporters/abstract_mod_exporter.php