restore_enrolments_structure_step Class Reference

Inheritance diagram for restore_enrolments_structure_step:

Collaboration diagram for restore_enrolments_structure_step:

Public Member Functions
	process_enrol ($data)
	process_enrolment ($data)
Protected Member Functions
	execute_condition ()
	define_structure ()

---

Detailed Description

This structure steps restores the enrol plugins and their underlying enrolments, performing all the mappings and/or movements required

Definition at line 1308 of file restore_stepslib.php.

---

Member Function Documentation

define_structure

(

)

[protected]

Function that will return the structure to be processed by this restore_step. Must return one array of elements

Reimplemented from restore_structure_step.

Definition at line 1332 of file restore_stepslib.php.

execute_condition

(

)

[protected]

Conditionally decide if this step should be executed.

This function checks the following parameter:

1. the course/enrolments.xml file exists

Returns:

bool true is safe to execute, false otherwise

Reimplemented from restore_structure_step.

Definition at line 1319 of file restore_stepslib.php.

process_enrol

(

$

data

)

Create enrolment instances.

This has to be called after creation of roles and before adding of role assignments.

Parameters:

mixed

$data

Returns:

void

Definition at line 1351 of file restore_stepslib.php.

Here is the call graph for this function:

process_enrolment

(

$

data

)

Create user enrolments

This has to be called after creation of enrolment instances and before adding of role assignments.

Parameters:

mixed

$data

Returns:

void

Definition at line 1417 of file restore_stepslib.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/backup/moodle2/restore_stepslib.php