restore_block_task Class Reference

Inheritance diagram for restore_block_task:

Collaboration diagram for restore_block_task:

Public Member Functions
	__construct ($name, $taskbasepath, $plan=null)
	get_taskbasepath ()
	build ()
	set_blockname ($blockname)
	get_blockname ()
	set_blockid ($blockid)
	get_blockid ()
	set_old_blockid ($blockid)
	get_old_blockid ()
	set_contextid ($contextid)
	get_contextid ()
	set_old_contextid ($contextid)
	get_old_contextid ()
	get_fileareas ()
	get_configdata_encoded_attributes ()
Static Public Member Functions
static	define_decode_contents ()
static	define_decode_rules ()
Protected Member Functions
	define_settings ()
	define_my_settings ()
	define_my_steps ()
Protected Attributes
	$taskbasepath
	$blockname
	$contextid
	$oldcontextid
	$blockid
	$oldblockid

---

Detailed Description

abstract block task that provides all the properties and common steps to be performed when one block is being restored

TODO: Finish phpdocs

Definition at line 31 of file restore_block_task.class.php.

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	taskbasepath,
		$	plan = null
	)

Constructor - instantiates one object of this class

Definition at line 43 of file restore_block_task.class.php.

---

Member Function Documentation

build

(

)

Create all the steps that will be part of this task

Reimplemented from base_task.

Definition at line 63 of file restore_block_task.class.php.

Here is the call graph for this function:

static define_decode_contents

(

)

[static]

Define the contents in the activity that must be processed by the link decoder

Reimplemented in restore_quiz_results_block_task, restore_glossary_random_block_task, restore_rss_client_block_task, restore_default_block_task, and restore_html_block_task.

Definition at line 155 of file restore_block_task.class.php.

static define_decode_rules

(

)

[static]

Define the decoding rules for links belonging to the activity to be executed by the link decoder

Reimplemented in restore_quiz_results_block_task, restore_glossary_random_block_task, restore_html_block_task, restore_rss_client_block_task, and restore_default_block_task.

Definition at line 163 of file restore_block_task.class.php.

define_my_settings

(

)

[abstract, protected]

Define (add) particular settings that each block can have

Reimplemented in restore_quiz_results_block_task, restore_rss_client_block_task, restore_default_block_task, restore_glossary_random_block_task, and restore_html_block_task.

Here is the caller graph for this function:

define_my_steps

(

)

[abstract, protected]

Define (add) particular steps that each block can have

Reimplemented in restore_quiz_results_block_task, restore_rss_client_block_task, restore_default_block_task, restore_glossary_random_block_task, and restore_html_block_task.

Here is the caller graph for this function:

define_settings

(

)

[protected]

Define the common setting that any backup block will have

Reimplemented from base_task.

Definition at line 172 of file restore_block_task.class.php.

Here is the call graph for this function:

get_blockid

(

)

Definition at line 112 of file restore_block_task.class.php.

Here is the caller graph for this function:

get_blockname

(

)

Definition at line 104 of file restore_block_task.class.php.

get_configdata_encoded_attributes

(

)

[abstract]

Define one array() of configdata attributes that need to be decoded

Reimplemented in restore_quiz_results_block_task, restore_rss_client_block_task, restore_default_block_task, restore_glossary_random_block_task, and restore_html_block_task.

get_contextid

(

)

Definition at line 128 of file restore_block_task.class.php.

get_fileareas

(

)

[abstract]

Define one array() of fileareas that each block controls

Reimplemented in restore_quiz_results_block_task, restore_rss_client_block_task, restore_default_block_task, restore_glossary_random_block_task, and restore_html_block_task.

get_old_blockid

(

)

Definition at line 120 of file restore_block_task.class.php.

get_old_contextid

(

)

Reimplemented from restore_task.

Definition at line 136 of file restore_block_task.class.php.

get_taskbasepath

(

)

Block tasks have their own directory to write files

Reimplemented from base_task.

Definition at line 56 of file restore_block_task.class.php.

set_blockid

(

$

blockid

)

Definition at line 108 of file restore_block_task.class.php.

set_blockname

(

$

blockname

)

Definition at line 100 of file restore_block_task.class.php.

set_contextid

(

$

contextid

)

Definition at line 124 of file restore_block_task.class.php.

set_old_blockid

(

$

blockid

)

Definition at line 116 of file restore_block_task.class.php.

set_old_contextid

(

$

contextid

)

Definition at line 132 of file restore_block_task.class.php.

---

Field Documentation

$blockid [protected]

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

$blockname [protected]

Definition at line 34 of file restore_block_task.class.php.

$contextid [protected]

Definition at line 35 of file restore_block_task.class.php.

$oldblockid [protected]

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

$oldcontextid [protected]

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

$taskbasepath [protected]

Definition at line 33 of file restore_block_task.class.php.

---

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

• C:/xampp/htdocs/moodle/backup/moodle2/restore_block_task.class.php