restore_plan Class Reference

Inheritance diagram for restore_plan:

Collaboration diagram for restore_plan:

Public Member Functions
	__construct ($controller)
	destroy ()
	build ()
	get_restoreid ()
	get_courseid ()
	get_mode ()
	get_basepath ()
	get_logger ()
	get_info ()
	get_target ()
	get_userid ()
	get_decoder ()
	is_samesite ()
	is_missing_modules ()
	is_excluding_activities ()
	set_preloaded_information ()
	get_preloaded_information ()
	get_tempdir ()
	set_missing_modules ()
	set_excluding_activities ()
	log ($message, $level, $a=null, $depth=null, $display=false)
	execute ()
	execute_after_restore ()
Protected Attributes
	$controller
	$basepath
	$preloaded
	$decoder
	$missingmodules
	$excludingdactivities

---

Detailed Description

Implementable class defining the needed stuf for one restore plan

TODO: Finish phpdocs

Definition at line 30 of file restore_plan.class.php.

---

Constructor & Destructor Documentation

__construct

(

$

controller

)

Constructor - instantiates one object of this class

Reimplemented from base_plan.

Definition at line 46 of file restore_plan.class.php.

Here is the call graph for this function:

---

Member Function Documentation

build

(

)

Function responsible for building the tasks of any plan with their corresponding settings (must set the $built property to true)

Reimplemented from base_plan.

Definition at line 72 of file restore_plan.class.php.

Here is the call graph for this function:

destroy

(

)

Destroy all circular references. It helps PHP 5.2 a lot!

Reimplemented from base_plan.

Definition at line 65 of file restore_plan.class.php.

execute

(

)

Function responsible for executing the tasks of any plan

Reimplemented from base_plan.

Definition at line 152 of file restore_plan.class.php.

execute_after_restore

(

)

Execute the after_restore methods of all the executed tasks in the plan

Definition at line 164 of file restore_plan.class.php.

get_basepath

(

)

Definition at line 89 of file restore_plan.class.php.

get_courseid

(

)

Definition at line 81 of file restore_plan.class.php.

get_decoder

(

)

Definition at line 109 of file restore_plan.class.php.

get_info

(

)

Definition at line 97 of file restore_plan.class.php.

Here is the caller graph for this function:

get_logger

(

)

Definition at line 93 of file restore_plan.class.php.

Here is the caller graph for this function:

get_mode

(

)

Definition at line 85 of file restore_plan.class.php.

get_preloaded_information

(

)

Definition at line 129 of file restore_plan.class.php.

get_restoreid

(

)

Definition at line 77 of file restore_plan.class.php.

Here is the caller graph for this function:

get_target

(

)

Definition at line 101 of file restore_plan.class.php.

get_tempdir

(

)

Definition at line 133 of file restore_plan.class.php.

get_userid

(

)

Definition at line 105 of file restore_plan.class.php.

is_excluding_activities

(

)

Definition at line 121 of file restore_plan.class.php.

is_missing_modules

(

)

Definition at line 117 of file restore_plan.class.php.

is_samesite

(

)

Definition at line 113 of file restore_plan.class.php.

log	(	$	message,
		$	level,
		$	a = null,
		$	depth = null,
		$	display = false
	)

This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed

Implements loggable.

Definition at line 145 of file restore_plan.class.php.

Here is the call graph for this function:

set_excluding_activities

(

)

Definition at line 141 of file restore_plan.class.php.

set_missing_modules

(

)

Definition at line 137 of file restore_plan.class.php.

set_preloaded_information

(

)

Definition at line 125 of file restore_plan.class.php.

---

Field Documentation

$basepath [protected]

Definition at line 37 of file restore_plan.class.php.

$controller [protected]

Definition at line 36 of file restore_plan.class.php.

$decoder [protected]

Definition at line 39 of file restore_plan.class.php.

$excludingdactivities [protected]

Definition at line 41 of file restore_plan.class.php.

$missingmodules [protected]

Definition at line 40 of file restore_plan.class.php.

$preloaded [protected]

Definition at line 38 of file restore_plan.class.php.

---

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

• C:/xampp/htdocs/moodle/backup/util/plan/restore_plan.class.php