backup_structure_step Class Reference

Inheritance diagram for backup_structure_step:

Collaboration diagram for backup_structure_step:

Public Member Functions
	__construct ($name, $filename, $task=null)
	execute ()
	get_task ()
Protected Member Functions
	add_plugin_structure ($plugintype, $element, $multiple)
	execute_condition ()
	define_structure ()
Protected Attributes
	$filename
	$contenttransformer

---

Detailed Description

Abstract class defining the needed stuff to backup one

TODO: Finish phpdocs

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

---

Constructor & Destructor Documentation

__construct	(	$	name,
		$	filename,
		$	task = null
	)

Constructor - instantiates one object of this class

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

---

Member Function Documentation

add_plugin_structure	(	$	plugintype,
		$	element,
		$	multiple
	)		[protected]

Add plugin structure to any element in the structure backup tree

Parameters:

string	$plugintype	type of plugin as defined by get_plugin_types()
backup_nested_element	$element	element in the structure backup tree that we are going to add plugin information to
bool	$multiple	to define if multiple plugins can produce information for each instance of $element (true) or no (false)

Definition at line 123 of file backup_structure_step.class.php.

Here is the call graph for this function:

Here is the caller graph for this function:

define_structure

(

)

[abstract, protected]

Function that will return the structure to be processed by this backup_step. Must return one backup_nested_element

Reimplemented in backup_course_completion_structure_step, backup_activity_grades_structure_step, backup_activity_grading_structure_step, backup_questions_structure_step, backup_main_structure_step, backup_final_files_structure_step, backup_inforef_structure_step, backup_activity_logs_structure_step, backup_course_logs_structure_step, backup_block_instance_structure_step, backup_users_structure_step, backup_groups_structure_step, backup_userscompletion_structure_step, backup_gradebook_structure_step, backup_comments_structure_step, backup_filters_structure_step, backup_final_outcomes_structure_step, backup_final_scales_structure_step, backup_final_roles_structure_step, backup_roles_structure_step, backup_enrolments_structure_step, backup_course_structure_step, backup_section_structure_step, mock_backup_structure_step, backup_module_structure_step, backup_lesson_activity_structure_step, backup_lti_activity_structure_step, backup_page_activity_structure_step, backup_quiz_activity_structure_step, backup_workshop_activity_structure_step, backup_rss_client_block_structure_step, backup_assignment_activity_structure_step, backup_choice_activity_structure_step, backup_data_activity_structure_step, backup_folder_activity_structure_step, backup_forum_activity_structure_step, backup_glossary_activity_structure_step, backup_imscp_activity_structure_step, backup_label_activity_structure_step, backup_resource_activity_structure_step, backup_survey_activity_structure_step, backup_url_activity_structure_step, backup_wiki_activity_structure_step, backup_feedback_activity_structure_step, backup_scorm_activity_structure_step, and backup_chat_activity_structure_step.

Here is the caller graph for this function:

execute

(

)

This function will perform all the actions necessary to achieve the execution of the plan/part/task

Implements executable.

Definition at line 50 of file backup_structure_step.class.php.

Here is the call graph for this function:

execute_condition

(

)

[protected]

To conditionally decide if one step will be executed or no

For steps needing to be executed conditionally, based in dynamic conditions (at execution time vs at declaration time) you must override this function. It will return true if the step must be executed and false if not

Reimplemented in backup_course_completion_structure_step, backup_activity_grading_structure_step, and backup_gradebook_structure_step.

Definition at line 159 of file backup_structure_step.class.php.

Here is the caller graph for this function:

get_task

(

)

As far as backup structure steps are implementing backup_plugin stuff, they need to have the parent task available for wrapping purposes (get course/context....)

Reimplemented in backup_activity_structure_step.

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

Here is the caller graph for this function:

---

Field Documentation

$contenttransformer [protected]

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

$filename [protected]

Definition at line 32 of file backup_structure_step.class.php.

---

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

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