Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
core_backup_external Class Reference

Backup external functions. More...

Inheritance diagram for core_backup_external:

Static Public Member Functions

static get_async_backup_links_backup ($filename, $contextid, $backupid)
 Get the data to be used when generating the table row for an asynchronous backup, the table row updates via ajax when backup is complete.
 
static get_async_backup_links_backup_parameters ()
 Returns description of method parameters.
 
static get_async_backup_links_backup_returns ()
 Returns description of method result value.
 
static get_async_backup_links_restore ($backupid, $contextid)
 Get the data to be used when generating the table row for an asynchronous restore, the table row updates via ajax when restore is complete.
 
static get_async_backup_links_restore_parameters ()
 Returns description of method parameters.
 
static get_async_backup_links_restore_returns ()
 Returns description of method result value.
 
static get_async_backup_progress ($backupids, $contextid)
 Get asynchronous backup progress.
 
static get_async_backup_progress_parameters ()
 Returns description of method parameters.
 
static get_async_backup_progress_returns ()
 Returns description of method result value.
 
static get_copy_progress ($copies)
 Get the data to be used when generating the table row for a course copy, the table row updates via ajax when copy is complete.
 
static get_copy_progress_parameters ()
 Returns description of method parameters.
 
static get_copy_progress_returns ()
 Returns description of method result value.
 
static submit_copy_form ($jsonformdata)
 Submit the course group form.
 
static submit_copy_form_parameters ()
 Returns description of method parameters.
 
static submit_copy_form_returns ()
 Returns description of method result value.
 

Detailed Description

Backup external functions.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
Moodle 3.7

Member Function Documentation

◆ get_async_backup_links_backup()

static core_backup_external::get_async_backup_links_backup ( $filename,
$contextid,
$backupid )
static

Get the data to be used when generating the table row for an asynchronous backup, the table row updates via ajax when backup is complete.

Parameters
string$filenameThe file name of the backup file.
int$contextidThe context the backup relates to.
string$backupidThe backup ID to get the backup settings.
Since
Moodle 3.7

◆ get_async_backup_links_backup_parameters()

static core_backup_external::get_async_backup_links_backup_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.7

◆ get_async_backup_links_backup_returns()

static core_backup_external::get_async_backup_links_backup_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.7

◆ get_async_backup_links_restore()

static core_backup_external::get_async_backup_links_restore ( $backupid,
$contextid )
static

Get the data to be used when generating the table row for an asynchronous restore, the table row updates via ajax when restore is complete.

Parameters
string$backupidThe id of the backup record.
int$contextidThe context the restore relates to.
Return values
array\$resultsThe array of results.
Since
Moodle 3.7

◆ get_async_backup_links_restore_parameters()

static core_backup_external::get_async_backup_links_restore_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.7

◆ get_async_backup_links_restore_returns()

static core_backup_external::get_async_backup_links_restore_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.7

◆ get_async_backup_progress()

static core_backup_external::get_async_backup_progress ( $backupids,
$contextid )
static

Get asynchronous backup progress.

Parameters
string$backupidsThe ids of the backup to get progress for.
int$contextidThe context the backup relates to.
Return values
array\$resultsThe array of results.
Since
Moodle 3.7

◆ get_async_backup_progress_parameters()

static core_backup_external::get_async_backup_progress_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.7

◆ get_async_backup_progress_returns()

static core_backup_external::get_async_backup_progress_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.7

◆ get_copy_progress()

static core_backup_external::get_copy_progress ( $copies)
static

Get the data to be used when generating the table row for a course copy, the table row updates via ajax when copy is complete.

Parameters
array$copiesArray of ids.
Return values
array\$resultsThe array of results.
Since
Moodle 3.9

◆ get_copy_progress_parameters()

static core_backup_external::get_copy_progress_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.9

◆ get_copy_progress_returns()

static core_backup_external::get_copy_progress_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.9

◆ submit_copy_form()

static core_backup_external::submit_copy_form ( $jsonformdata)
static

Submit the course group form.

Parameters
string$jsonformdataThe data from the form, encoded as a json array.
Return values
intnew group id.

◆ submit_copy_form_parameters()

static core_backup_external::submit_copy_form_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.9

◆ submit_copy_form_returns()

static core_backup_external::submit_copy_form_returns ( )
static

Returns description of method result value.

Return values
core_external\external_description
Since
Moodle 3.9

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