backup_block_task Class Reference

Inheritance diagram for backup_block_task:

Collaboration diagram for backup_block_task:

Public Member Functions
	__construct ($name, $blockid, $moduleid=null, $plan=null)
	get_blockid ()
	get_blockname ()
	get_moduleid ()
	get_modulename ()
	get_contextid ()
	get_parentcontextid ()
	get_taskbasepath ()
	build ()
	get_fileareas ()
	get_configdata_encoded_attributes ()
Static Public Member Functions
static	encode_content_links ($content)
Protected Member Functions
	define_settings ()
	define_my_settings ()
	define_my_steps ()
Protected Attributes
	$blockid
	$blockname
	$contextid
	$moduleid
	$modulename
	$parentcontextid

---

Detailed Description

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

TODO: Finish phpdocs

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

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	blockid,
		$	moduleid = null,
		$	plan = null
	)

Constructor - instantiates one object of this class

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

Here is the call graph for this function:

---

Member Function Documentation

build

(

)

Create all the steps that will be part of this task

Reimplemented from base_task.

Definition at line 122 of file backup_block_task.class.php.

Here is the call graph for this function:

define_my_settings

(

)

[abstract, protected]

Define (add) particular settings that each block can have

Reimplemented in backup_default_block_task, backup_rss_client_block_task, and backup_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 backup_default_block_task, backup_rss_client_block_task, and backup_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 180 of file backup_block_task.class.php.

Here is the call graph for this function:

static encode_content_links

(

$

content

)

[static]

Code the transformations to perform in the block in order to get transportable (encoded) links

Reimplemented in backup_rss_client_block_task, backup_default_block_task, and backup_html_block_task.

Definition at line 213 of file backup_block_task.class.php.

get_blockid

(

)

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

get_blockname

(

)

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

get_configdata_encoded_attributes

(

)

[abstract]

Define one array() of configdata attributes that need to be processed by the contenttransformer

Reimplemented in backup_rss_client_block_task, backup_default_block_task, and backup_html_block_task.

get_contextid

(

)

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

get_fileareas

(

)

[abstract]

Define one array() of fileareas that each block controls

Reimplemented in backup_rss_client_block_task, backup_default_block_task, and backup_html_block_task.

get_moduleid

(

)

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

get_modulename

(

)

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

get_parentcontextid

(

)

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

get_taskbasepath

(

)

Block tasks have their own directory to write files

Reimplemented from base_task.

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

Here is the call graph for this function:

---

Field Documentation

$blockid [protected]

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

$blockname [protected]

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

$contextid [protected]

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

$moduleid [protected]

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

$modulename [protected]

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

$parentcontextid [protected]

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

---

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

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