Backup API - Revision history

Devdocsbot: Protected "Backup API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-07-20T05:50:22Z

Protected "Backup API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 05:50, 20 July 2022
(No difference)

Devdocsbot: Update migration status and path

2022-07-20T05:47:50Z

Update migration status and path

← Older revision		Revision as of 05:47, 20 July 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/backup/}}
	{{Moodle 2.0}}The Backup API provides a way to include your plugin's in the course backup. See [[Restore API]] for the part that takes care of restoring data.		{{Moodle 2.0}}The Backup API provides a way to include your plugin's in the course backup. See [[Restore API]] for the part that takes care of restoring data.

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:35:24Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:35, 14 July 2021
				
Line 76:
Line 76:
Here is a minimalistic task: Here is a minimalistic task:



<code php> <syntaxhighlight lang="php">
require_once($CFG->dirroot . '/backup/moodle2/backup_tool_plugin.class.php'); require_once($CFG->dirroot . '/backup/moodle2/backup_tool_plugin.class.php');

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:07:06Z

Text replacement - "</code>" to "</syntaxhighlight>"

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:04:52Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:04, 14 July 2021
				
Line 29:
Line 29:



; protected function define_my_settings() : If your module declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most modules just leave the method body empty. ; protected function define_my_settings() : If your module declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most modules just leave the method body empty.
; protected function define_my_steps() : This method typically consists of one or more <code>$this->add_step()</code> calls. This is the place where you define the task as a sequence of steps to execute. ; protected function define_my_steps() : This method typically consists of one or more <syntaxhighlight lang="php">$this->add_step()</code> calls. This is the place where you define the task as a sequence of steps to execute.
; static public function encode_content_links($content) : The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/foobar/view.php?id=42 Obviously, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site. ; static public function encode_content_links($content) : The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/foobar/view.php?id=42 Obviously, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site.



Line 36:
Line 36:
The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources. The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.



You have to implement a single method <code>protected function define_structure()</code> in this class class. There are three main things that the method must do. You have to implement a single method <syntaxhighlight lang="php">protected function define_structure()</code> in this class class. There are three main things that the method must do.



* Create a set of backup_nested_element instances that describe the required data of your plugin * Create a set of backup_nested_element instances that describe the required data of your plugin
* Connect these instances into a hierarchy using their <code>add_child()</code> method * Connect these instances into a hierarchy using their <syntaxhighlight lang="php">add_child()</code> method
* Set data sources for the elements, using their methods like <code>set_source_table()</code> or <code>set_source_sql()</code> * Set data sources for the elements, using their methods like <syntaxhighlight lang="php">set_source_table()</code> or <syntaxhighlight lang="php">set_source_sql()</code>



The method must return the root backup_nested_element instance processed by the <code>prepare_activity_structure()</code> method (which just wraps your structures with a common envelope). The method must return the root backup_nested_element instance processed by the <syntaxhighlight lang="php">prepare_activity_structure()</code> method (which just wraps your structures with a common envelope).



== API for blocks == == API for blocks ==
Line 61:
Line 61:



; protected function define_my_settings() : If your block declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most blocks just leave the method body empty. ; protected function define_my_settings() : If your block declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most blocks just leave the method body empty.
; protected function define_my_steps() : Blocks that do not have their own database tables usually leave this method empty. Otherwise this method consists of one or more <code>$this->add_step()</code> calls where you define the task as a sequence of steps to execute. ; protected function define_my_steps() : Blocks that do not have their own database tables usually leave this method empty. Otherwise this method consists of one or more <syntaxhighlight lang="php">$this->add_step()</code> calls where you define the task as a sequence of steps to execute.
; public function get_fileareas() : Returns the array of file area names within the block context. ; public function get_fileareas() : Returns the array of file area names within the block context.
; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here. ; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here.



Fmcorz at 07:03, 28 November 2016
2016-11-28T07:03:45Z


				
				
				
				
				
				← Older revision
				Revision as of 07:03, 28 November 2016
				
Line 65:
Line 65:
; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here. ; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here.
; static public function encode_content_links($content) : If the current instance of the block may be referenced from other places in the course by URLs, it must be encoded into a transportable form. Most blocks just return unmodified $content parameter. ; static public function encode_content_links($content) : If the current instance of the block may be referenced from other places in the course by URLs, it must be encoded into a transportable form. Most blocks just return unmodified $content parameter.

== API for admin tools ==

The files that implement the backup support in your plugin must be located in the subdirectory ''backup/moodle2/'' in your plugin's folder. So, if you are developing ''tool_foobar'' then the backup files will be located in ''admin/tool/foobar/backup/moodle2/''.

=== Task class ===

The file  backup_tool_foobar_plugin.class.php must provide a single class called ''backup_tool_foobar_task'' extending ''backup_tool_plugin''.

Here is a minimalistic task:

<code php>
require_once($CFG->dirroot . '/backup/moodle2/backup_tool_plugin.class.php');

class backup_tool_foobar_plugin extends backup_tool_plugin {
    
    protected function define_course_plugin_structure() {
        $this->step->log('Yay, backup!', backup::LOG_DEBUG);
        return $plugin;
    }

}
</code>



== API for themes == == API for themes ==



Fmcorz: Adding see also 'Restore API'
2015-03-13T09:26:00Z
Adding see also 'Restore API'

				
				
				
				
				
				← Older revision
				Revision as of 09:26, 13 March 2015
				
Line 77:
Line 77:
==See also== ==See also==



* [[Restore API]]
* [[Core APIs]] * [[Core APIs]]



[[Category:API]] [[Category:API]]
[[Category:Backup]] [[Category:Backup]]



Fmcorz: Add backup category to this page
2015-03-13T09:24:50Z
Add backup category to this page

				
				
				
				
				
				← Older revision
				Revision as of 09:24, 13 March 2015
				
Line 80:
Line 80:



[[Category:API]] [[Category:API]]
[[Category:Backup]]



Mudrd8mz: /* Backup structure step class */ typos
2012-01-26T11:47:24Z
Backup structure step class:  typos

				
				
				
				
				
				← Older revision
				Revision as of 11:47, 26 January 2012
				
Line 36:
Line 36:
The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources. The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.



You have to implement a single method <code>protected function define_structure()</code> in this class class. There are three main things that the methods must do. You have to implement a single method <code>protected function define_structure()</code> in this class class. There are three main things that the method must do.



* Create a set of backup_nested_element instances that described the required data of your plugin * Create a set of backup_nested_element instances that describe the required data of your plugin
* Connect these instances into a hierarchy using their <code>add_child()</code> method * Connect these instances into a hierarchy using their <code>add_child()</code> method
* Set data sources for the elements, using their methods like <code>set_source_table()</code> or <code>set_source_sql()</code> * Set data sources for the elements, using their methods like <code>set_source_table()</code> or <code>set_source_sql()</code>



Dougiamas: /* API for reports */
2012-01-25T08:53:08Z
API for reports

				
				
				
				
				
				← Older revision
				Revision as of 08:53, 25 January 2012
				
Line 73:
Line 73:



See [[Backup 2.0 course report data]] See [[Backup 2.0 course report data]]


==See also==

* [[Core APIs]]

[[Category:API]]

← Older revision		Revision as of 13:35, 14 July 2021
Line 76:		Line 76:
	Here is a minimalistic task:		Here is a minimalistic task:

	<~~code~~ php>		<syntaxhighlight lang="php">
	require_once($CFG->dirroot . '/backup/moodle2/backup_tool_plugin.class.php');		require_once($CFG->dirroot . '/backup/moodle2/backup_tool_plugin.class.php');

← Older revision		Revision as of 13:07, 14 July 2021
Line 29:		Line 29:

	; protected function define_my_settings() : If your module declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most modules just leave the method body empty.		; protected function define_my_settings() : If your module declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most modules just leave the method body empty.
	; protected function define_my_steps() : This method typically consists of one or more <syntaxhighlight lang="php">$this->add_step()</~~code~~> calls. This is the place where you define the task as a sequence of steps to execute.		; protected function define_my_steps() : This method typically consists of one or more <syntaxhighlight lang="php">$this->add_step()</syntaxhighlight> calls. This is the place where you define the task as a sequence of steps to execute.
	; static public function encode_content_links($content) : The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/foobar/view.php?id=42 Obviously, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site.		; static public function encode_content_links($content) : The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/foobar/view.php?id=42 Obviously, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site.

Line 36:		Line 36:
	The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.		The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.

	You have to implement a single method <syntaxhighlight lang="php">protected function define_structure()</~~code~~> in this class class. There are three main things that the method must do.		You have to implement a single method <syntaxhighlight lang="php">protected function define_structure()</syntaxhighlight> in this class class. There are three main things that the method must do.

	* Create a set of backup_nested_element instances that describe the required data of your plugin		* Create a set of backup_nested_element instances that describe the required data of your plugin
	* Connect these instances into a hierarchy using their <syntaxhighlight lang="php">add_child()</~~code~~> method		* Connect these instances into a hierarchy using their <syntaxhighlight lang="php">add_child()</syntaxhighlight> method
	* Set data sources for the elements, using their methods like <syntaxhighlight lang="php">set_source_table()</~~code~~> or <syntaxhighlight lang="php">set_source_sql()</~~code~~>		* Set data sources for the elements, using their methods like <syntaxhighlight lang="php">set_source_table()</syntaxhighlight> or <syntaxhighlight lang="php">set_source_sql()</syntaxhighlight>

	The method must return the root backup_nested_element instance processed by the <syntaxhighlight lang="php">prepare_activity_structure()</~~code~~> method (which just wraps your structures with a common envelope).		The method must return the root backup_nested_element instance processed by the <syntaxhighlight lang="php">prepare_activity_structure()</syntaxhighlight> method (which just wraps your structures with a common envelope).

	== API for blocks ==		== API for blocks ==
Line 61:		Line 61:

	; protected function define_my_settings() : If your block declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most blocks just leave the method body empty.		; protected function define_my_settings() : If your block declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most blocks just leave the method body empty.
	; protected function define_my_steps() : Blocks that do not have their own database tables usually leave this method empty. Otherwise this method consists of one or more <syntaxhighlight lang="php">$this->add_step()</~~code~~> calls where you define the task as a sequence of steps to execute.		; protected function define_my_steps() : Blocks that do not have their own database tables usually leave this method empty. Otherwise this method consists of one or more <syntaxhighlight lang="php">$this->add_step()</syntaxhighlight> calls where you define the task as a sequence of steps to execute.
	; public function get_fileareas() : Returns the array of file area names within the block context.		; public function get_fileareas() : Returns the array of file area names within the block context.
	; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here.		; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here.
Line 87:		Line 87:

	}		}
	</~~code~~>		</syntaxhighlight>

	== API for themes ==		== API for themes ==

← Older revision		Revision as of 13:04, 14 July 2021
Line 29:		Line 29:

	; protected function define_my_settings() : If your module declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most modules just leave the method body empty.		; protected function define_my_settings() : If your module declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most modules just leave the method body empty.
	; protected function define_my_steps() : This method typically consists of one or more <~~code~~>$this->add_step()</code> calls. This is the place where you define the task as a sequence of steps to execute.		; protected function define_my_steps() : This method typically consists of one or more <syntaxhighlight lang="php">$this->add_step()</code> calls. This is the place where you define the task as a sequence of steps to execute.
	; static public function encode_content_links($content) : The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/foobar/view.php?id=42 Obviously, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site.		; static public function encode_content_links($content) : The current instance of the activity may be referenced from other places in the course by URLs like http://my.moodle.site/mod/foobar/view.php?id=42 Obviously, such URLs are not valid any more once the course is restored elsewhere. For this reason the backup file does not store the original URLs but encodes them into a transportable form. During the restore, the reverse process is applied and the encoded URLs are replaced with the new ones valid for the target site.

Line 36:		Line 36:
	The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.		The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.

	You have to implement a single method <~~code~~>protected function define_structure()</code> in this class class. There are three main things that the method must do.		You have to implement a single method <syntaxhighlight lang="php">protected function define_structure()</code> in this class class. There are three main things that the method must do.

	* Create a set of backup_nested_element instances that describe the required data of your plugin		* Create a set of backup_nested_element instances that describe the required data of your plugin
	* Connect these instances into a hierarchy using their <~~code~~>add_child()</code> method		* Connect these instances into a hierarchy using their <syntaxhighlight lang="php">add_child()</code> method
	* Set data sources for the elements, using their methods like <~~code~~>set_source_table()</code> or <~~code~~>set_source_sql()</code>		* Set data sources for the elements, using their methods like <syntaxhighlight lang="php">set_source_table()</code> or <syntaxhighlight lang="php">set_source_sql()</code>

	The method must return the root backup_nested_element instance processed by the <~~code~~>prepare_activity_structure()</code> method (which just wraps your structures with a common envelope).		The method must return the root backup_nested_element instance processed by the <syntaxhighlight lang="php">prepare_activity_structure()</code> method (which just wraps your structures with a common envelope).

	== API for blocks ==		== API for blocks ==
Line 61:		Line 61:

	; protected function define_my_settings() : If your block declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most blocks just leave the method body empty.		; protected function define_my_settings() : If your block declares own backup settings defined in the file backup_foobar_settingslib.php, add them here. Most blocks just leave the method body empty.
	; protected function define_my_steps() : Blocks that do not have their own database tables usually leave this method empty. Otherwise this method consists of one or more <~~code~~>$this->add_step()</code> calls where you define the task as a sequence of steps to execute.		; protected function define_my_steps() : Blocks that do not have their own database tables usually leave this method empty. Otherwise this method consists of one or more <syntaxhighlight lang="php">$this->add_step()</code> calls where you define the task as a sequence of steps to execute.
	; public function get_fileareas() : Returns the array of file area names within the block context.		; public function get_fileareas() : Returns the array of file area names within the block context.
	; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here.		; public function get_configdata_encoded_attributes() : Instead of using their own tables, blocks usually use the configuration tables to hold their data (see the instance_config_save() of the block class). This method returns the array of all config elements that must be processed before they are stored in the backup. This is typically used when the stored config elements holds links to embedded media. Most blocks just return empty array here.

← Older revision		Revision as of 09:26, 13 March 2015
Line 77:		Line 77:
	==See also==		==See also==

			* [[Restore API]]
	* [[Core APIs]]		* [[Core APIs]]

	[[Category:API]]		[[Category:API]]
	[[Category:Backup]]		[[Category:Backup]]

← Older revision		Revision as of 09:24, 13 March 2015
Line 80:		Line 80:

	[[Category:API]]		[[Category:API]]
			[[Category:Backup]]

← Older revision		Revision as of 11:47, 26 January 2012
Line 36:		Line 36:
	The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.		The classes that represent the backup steps added in define_my_steps() are implemented in the file backup_foobar_stepslib.php. Most plugins define just a single step in the class called '''backup_foobar_activity_structure_step''' that extends the backup_activity_structure_step class. This class defines the structure step - that is the step where the structure of your plugin's instance data is described and linked with the data sources.

	You have to implement a single method <code>protected function define_structure()</code> in this class class. There are three main things that the ~~methods~~ must do.		You have to implement a single method <code>protected function define_structure()</code> in this class class. There are three main things that the method must do.

	* Create a set of backup_nested_element instances that ~~described~~ the required data of your plugin		* Create a set of backup_nested_element instances that describe the required data of your plugin
	* Connect these instances into a hierarchy using their <code>add_child()</code> method		* Connect these instances into a hierarchy using their <code>add_child()</code> method
	* Set data sources for the elements, using their methods like <code>set_source_table()</code> or <code>set_source_sql()</code>		* Set data sources for the elements, using their methods like <code>set_source_table()</code> or <code>set_source_sql()</code>

← Older revision		Revision as of 08:53, 25 January 2012
Line 73:		Line 73:

	See [[Backup 2.0 course report data]]		See [[Backup 2.0 course report data]]


			==See also==

			* [[Core APIs]]

			[[Category:API]]

Backup API - Revision history

Devdocsbot: Protected "Backup API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Fmcorz at 07:03, 28 November 2016

Fmcorz: Adding see also 'Restore API'

Fmcorz: Add backup category to this page

Mudrd8mz: /* Backup structure step class */ typos

Dougiamas: /* API for reports */

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""

Mudrd8mz: Text replacement - "`" to ""`