Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Attributes | List of all members
data_preset_existing_importer Class Reference

Data preset importer for existing presets. More...

Inheritance diagram for data_preset_existing_importer:
data_preset_importer

Public Member Functions

 __construct ($course, $cm, $module, $fullname)
 Constructor. More...
 
 cleanup ()
 Any clean up routines should go here. More...
 
 data_preset_get_file_contents (&$filestorage, &$fileobj, $dir, $filename)
 Retreive the contents of a file. More...
 
 get_directory ()
 Returns the name of the directory the preset is located in. More...
 
moodle_database get_preset_settings ()
 Gets the preset settings $DB. More...
 
 get_userid ()
 
 import ($overwritesettings)
 Import the preset into the given database module. More...
 

Protected Attributes

 $cm
 
 $course
 
 $directory
 
 $module
 
 $userid
 

Detailed Description

Data preset importer for existing presets.

Constructor & Destructor Documentation

◆ __construct()

data_preset_existing_importer::__construct (   $course,
  $cm,
  $module,
  $directory 
)

Constructor.

Parameters
stdClass$course
stdClass$cm
stdClass$module
string$directory

Reimplemented from data_preset_importer.

Member Function Documentation

◆ cleanup()

data_preset_importer::cleanup ( )
inherited

Any clean up routines should go here.

Return values
bool

Reimplemented in data_preset_upload_importer.

◆ data_preset_get_file_contents()

data_preset_importer::data_preset_get_file_contents ( $filestorage,
$fileobj,
  $dir,
  $filename 
)
inherited

Retreive the contents of a file.

That file may either be in a conventional directory of the Moodle file storage

Parameters
file_storage$filestorage,.should be null if using a conventional directory
stored_file$fileobjthe directory to look in. null if using a conventional directory
string$dirthe directory to look in. null if using the Moodle file storage
string$filenamethe name of the file we want
Return values
stringthe contents of the file or null if the file doesn't exist.

◆ get_directory()

data_preset_importer::get_directory ( )
inherited

Returns the name of the directory the preset is located in.

Return values
string

◆ get_preset_settings()

moodle_database data_preset_importer::get_preset_settings ( )
inherited

Gets the preset settings $DB.

Return values
stdClass

◆ import()

data_preset_importer::import (   $overwritesettings)
inherited

Import the preset into the given database module.

Return values
bool

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