Restore API - Revision history

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

2022-07-20T05:52:23Z

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

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

Devdocsbot: Update migration status and path

2022-07-20T05:50:01Z

Update migration status and path

← Older revision		Revision as of 05:50, 20 July 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/subsystems/backup/restore}}
	{{Moodle 2.0}}The Restore API provides a way to restore your plugin's data from a backup file created in Moodle 2.0 or later. For the information on how backup files are created, see [[Backup API]]. For the information on how to support restoring data from backup files created in Moodle 1.x, see [[Backup conversion API]].		{{Moodle 2.0}}The Restore API provides a way to restore your plugin's data from a backup file created in Moodle 2.0 or later. For the information on how backup files are created, see [[Backup API]]. For the information on how to support restoring data from backup files created in Moodle 1.x, see [[Backup conversion API]].

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:19:43Z

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

← Older revision		Revision as of 20:19, 14 July 2021
Line 42:		Line 42:

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

	== See also ==		== See also ==

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


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

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



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



Fmcorz: /* API for activity modules */
2016-11-28T07:05:08Z
API for activity modules

				
				
				
				
				
				← Older revision
				Revision as of 07:05, 28 November 2016
				
Line 20:
Line 20:
(to be continued) (to be continued)



== 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 ''restore_tool_foobar_task'' extending ''restore_tool_plugin''.

Here is a minimalistic task:

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

class restore_tool_foobar_plugin extends restore_tool_plugin {

    protected function define_course_plugin_structure() {
        $paths = array();
        $this->step->log('Yay, restore!', backup::LOG_DEBUG);
        return $paths;
    }

}
</code>



== See also == == See also ==



Fmcorz: Adding backup category
2015-03-13T09:35:39Z
Adding backup category

				
				
				
				
				
				← Older revision
				Revision as of 09:35, 13 March 2015
				
Line 27:
Line 27:



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



Dougiamas: /* Files */
2012-01-25T08:53:52Z
Files

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



(to be continued) (to be continued)


== See also ==

* [[Core APIs]]
* [[Backup API]]

[[Category:API]]



Mudrd8mz: The scaffold of the page
2012-01-24T10:41:18Z
The scaffold of the page
New page
{{Moodle 2.0}}The Restore API provides a way to restore your plugin's data from a backup file created in Moodle 2.0 or later. For the information on how backup files are created, see [[Backup API]]. For the information on how to support restoring data from backup files created in Moodle 1.x, see [[Backup conversion API]].



== Overview ==



This page provides just a quick reference to the restore machinery in Moodle 2.0 and higher. There is a detailed documentation available at [[Backup 2.0]] page - see especially the tutorial for plugin authors at [[Restore 2.0 for developers]] page.



Moodle restores data from course backups by executing so called ''restore plan''. The restore plan consists of a set of ''restore tasks'' and finally each restore task consists of one or more ''restore steps''. You as the developer of a plugin will have to implement one restore task that deals with your plugin data. Most plugins have their restore tasks consisting of a single restore step - the one that parses the plugin XML file and puts the data into its tables.



== API for activity modules ==



=== Files ===



The files that implement the restore support in your activity module must be located in the subdirectory backup/moodle2/ in your plugin's folder (yes, it's the same folder where the backup related files are located). So, if you are developing the activity module called ''foobar'' then the restore files will be located in mod/foobar/backup/moodle2/ folder.



The following two files are supposed to exist in that location (replace ''foobar'' with the name of your module):



; restore_foobar_activity_task.class.php : Provides the activity task class

; restore_foobar_stepslib.php : Provides all the restore steps classes



(to be continued)

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

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

← Older revision		Revision as of 07:05, 28 November 2016
Line 20:		Line 20:
	(to be continued)		(to be continued)

			== 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 ''restore_tool_foobar_task'' extending ''restore_tool_plugin''.

			Here is a minimalistic task:

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

			class restore_tool_foobar_plugin extends restore_tool_plugin {

			protected function define_course_plugin_structure() {
			$paths = array();
			$this->step->log('Yay, restore!', backup::LOG_DEBUG);
			return $paths;
			}

			}
			</code>

	== See also ==		== See also ==

← Older revision		Revision as of 09:35, 13 March 2015
Line 27:		Line 27:

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

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

	(to be continued)		(to be continued)


			== See also ==

			* [[Core APIs]]
			* [[Backup API]]

			[[Category:API]]