Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
mod_data\local\exporter\utils Class Reference

Utility class for exporting data from a mod_data instance. More...

Static Public Member Functions

static data_exportdata (int $dataid, array $fields, array $selectedfields, entries_exporter $exporter, int $currentgroup=0, context $context=null, bool $userdetails=false, bool $time=false, bool $approval=false, bool $tags=false, bool $includefiles=true)
 Exports the data of the mod_data instance to an entries_exporter object which then can export it to a file format.
 

Detailed Description

Utility class for exporting data from a mod_data instance.

Author
Philipp Memmel
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ data_exportdata()

static mod_data\local\exporter\utils::data_exportdata ( int $dataid,
array $fields,
array $selectedfields,
entries_exporter $exporter,
int $currentgroup = 0,
context $context = null,
bool $userdetails = false,
bool $time = false,
bool $approval = false,
bool $tags = false,
bool $includefiles = true )
static

Exports the data of the mod_data instance to an entries_exporter object which then can export it to a file format.

Parameters
int$dataid
array$fields
array$selectedfields
entries_exporter$exporterthe entries_exporter object used
int$currentgroupgroup ID of the current group. This is used for exporting data while maintaining group divisions.
context | null$contextthe context in which the operation is performed (for capability checks)
bool$userdetailswhether to include the details of the record author
bool$timewhether to include time created/modified
bool$approvalwhether to include approval status
bool$tagswhether to include tags
bool$includefileswhether files should be exported as well
Return values
void

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