backup_section_task Class Reference

section task that provides all the properties and common steps to be performed when one section is being backup More...

Inheritance diagram for backup_section_task:

Public Member Functions
	__construct ($name, $sectionid, $plan=null)
	Constructor - instantiates one object of this class.
	add_result ($result)
	Add the given info to the current plan's results.
	add_setting ($setting)
	Add a setting to the task.
	add_step ($step)
	build ()
	Create all the steps that will be part of this task.
	calculate_checksum ()
	This function will return one unique and stable checksum for one instance of the class implementing it.
	destroy ()
	Destroy all circular references.
	execute ()
	Exceptionally override the execute method, so, based in the section_included setting, we are able to skip the execution of one task completely.
	get_backupid ()
	get_basepath ()
	get_courseid ()
	get_delegated_cm ()
	Get the course module that is delegating this section.
	get_kept_roles ()
	Get the user roles that should be kept in the destination course for a course copy operation.
	get_logger ()
	get_modname ()
	Get the delegate activity modname (if any).
	get_name ()
	get_progress ()
	Gets the progress reporter, which can be used to report progress within the backup or restore process.
	get_results ()
	Return the current plan's results.
	get_sectionid ()
	get_setting ($name)
	Specialisation that, first of all, looks for the setting within the task with the the prefix added and later, delegates to parent without adding anything.
	get_setting_value ($name)
	get_settings ()
	get_steps ()
	get_taskbasepath ()
	Section tasks have their own directory to write files.
	get_weight ()
	Returns the weight of this task, an approximation of the amount of time it will take.
	is_checksum_correct ($checksum)
	Given one checksum, returns if matches object's checksum (true) or no (false)
	is_excluding_activities ()
	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.
	set_delegated_cm (int $cmid)
	Set the course module that is delegating this section.
	set_plan ($plan)
	setting_exists ($name)
	Check if a setting with the given name exists.

Protected Member Functions
	add_section_included_setting (string $settingprefix)
	Add the section included setting to the task.
	add_section_setting (int|string $identifier, string $type, string|int $value)
	Add a setting to the task.
	add_section_userinfo_setting (string $settingprefix, section_backup_setting $includefield)
	Add the section userinfo setting to the task.
	define_settings ()
	Define the common setting that any backup section will have.

Protected Attributes
bool	$built
int null int	$delegatedcmid = null
	$delegatedcmid the course module that is delegating this section (if any)
bool	$executed
string	$name
backup_plan restore_plan	$plan
stdClass stdClass	$section
	$section The database section object.
	$sectionid
base_setting[]	$settings
base_step[]	$steps

Detailed Description

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

TODO: Finish phpdocs

Member Function Documentation

add_result()

base_task::add_result ( $result )

inherited

Add the given info to the current plan's results.

See also

base_plan\add_result()

Parameters

array

$result

associative array describing a result of a task/step

add_section_included_setting()

backup_section_task::add_section_included_setting ( string $settingprefix )

protected

Add the section included setting to the task.

Parameters

string

$settingprefix

the identifier of the setting

Return values

section_backup_setting

the setting added

add_section_setting()

backup_section_task::add_section_setting ( int|string $identifier, string $type, string|int $value )

protected

Add a setting to the task.

This method is used to add a setting to the task

Parameters

int | string	$identifier	the identifier of the setting
string	$type	the type of the setting
string | int	$value	the value of the setting

Return values

section_backup_setting

the setting added

add_section_userinfo_setting()

backup_section_task::add_section_userinfo_setting ( string $settingprefix, section_backup_setting $includefield )

protected

Add the section userinfo setting to the task.

Parameters

string	$settingprefix	the identifier of the setting
section_backup_setting	$includefield	the setting to depend on

Return values

section_backup_setting

the setting added

add_setting()

base_task::add_setting ( $setting )

inherited

Add a setting to the task.

Parameters

base_setting

$setting

Return values

void

build()

backup_section_task::build

(

)

Create all the steps that will be part of this task.

Reimplemented from base_task.

calculate_checksum()

base_task::calculate_checksum ( )

inherited

This function will return one unique and stable checksum for one instance of the class implementing it.

It's each implementation responsibility to do it recursively if needed and use optional store (caching) of the checksum if necessary/possible

Implements checksumable.

define_settings()

backup_section_task::define_settings ( )

protected

Define the common setting that any backup section will have.

Reimplemented from base_task.

destroy()

base_task::destroy ( )

inherited

Destroy all circular references.

It helps PHP 5.2 a lot!

execute()

backup_section_task::execute

(

)

Exceptionally override the execute method, so, based in the section_included setting, we are able to skip the execution of one task completely.

Reimplemented from base_task.

get_delegated_cm()

backup_section_task::get_delegated_cm

(

)

Get the course module that is delegating this section.

Return values

int|null

the course module id that is delegating this section

get_kept_roles()

backup_task::get_kept_roles ( )

inherited

Get the user roles that should be kept in the destination course for a course copy operation.

Return values

array

get_modname()

backup_section_task::get_modname

(

)

Get the delegate activity modname (if any).

Return values

string|null

the modname of the delegated activity

get_progress()

base_task::get_progress ( )

inherited

Gets the progress reporter, which can be used to report progress within the backup or restore process.

Return values

core\progress\base

Progress reporting object

get_results()

base_task::get_results ( )

inherited

Return the current plan's results.

Return values

array|null

get_setting()

backup_section_task::get_setting

(

$name

)

Specialisation that, first of all, looks for the setting within the task with the the prefix added and later, delegates to parent without adding anything.

Reimplemented from base_task.

get_taskbasepath()

backup_section_task::get_taskbasepath

(

)

Section tasks have their own directory to write files.

Reimplemented from base_task.

get_weight()

base_task::get_weight ( )

inherited

Returns the weight of this task, an approximation of the amount of time it will take.

By default this value is 1. It can be increased for longer tasks.

Return values

int

Weight

Reimplemented in backup_final_task.

is_checksum_correct()

base_task::is_checksum_correct ( $checksum )

inherited

Given one checksum, returns if matches object's checksum (true) or no (false)

Implements checksumable.

log()

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

inherited

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.

set_delegated_cm()

backup_section_task::set_delegated_cm

(

int

$cmid

)

Set the course module that is delegating this section.

Delegated section can belong to any kind of plugin. However, when a delegated section belongs to a course module, the UI will present all settings according.

Parameters

int

$cmid

the course module id that is delegating this section

setting_exists()

base_task::setting_exists ( $name )

inherited

Check if a setting with the given name exists.

This method find first in the current settings and then in the plan settings.

Parameters

string

$name

Setting name

Return values

bool

---

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

• backup/moodle2/backup_section_task.class.php