Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
mod_resource\content\exporter Class Reference

A class which assists a component to export content. More...

Inheritance diagram for mod_resource\content\exporter:
core\content\export\exporters\abstract_mod_exporter core\content\export\exporters\component_exporter

Public Member Functions

 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 mod_resource.
 

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

A class which assists a component to export content.

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$componentThe component to fetch a classname for
Return values
stringThe 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()

mod_resource\content\exporter::get_exportables ( bool $includeuserdata = false)

Get the exportable items for mod_resource.

Parameters
bool$includeuserdataWhether to include user data, in addition to shared content.
Return values
core\content\export\exportable_item[]

Reimplemented from core\content\export\exporters\abstract_mod_exporter.

◆ get_modname()

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

Get the modname for the activity.

Return values
string

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