Introduced the functionality to backup and restore the customcert

2013-07-23 13:21:54 +08:00 · 2013-07-23 13:21:54 +08:00 · 323abd6da4
commit 323abd6da4
parent 2df3ee4fa5
7 changed files with 456 additions and 1 deletions
--- a/backup/moodle2/backup_customcert_stepslib.php
+++ b/backup/moodle2/backup_customcert_stepslib.php
@ -0,0 +1,87 @@
+<?php
+// This file is part of the customcert module for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Define all the backup steps that will be used by the backup_customcert_activity_task.
+ *
+ * @package    mod_customcert
+ * @copyright  2013 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
+
+/**
+ * Define the complete customcert structure for backup, with file and id annotations.
+ */
+class backup_customcert_activity_structure_step extends backup_activity_structure_step {
+
+    /**
+     * Define the structure of the backup file.
+     *
+     * @return backup_nested_element
+     */
+    protected function define_structure() {
+
+        // The instance.
+        $customcert = new backup_nested_element('customcert', array('id'), array(
+            'name', 'intro', 'introformat', 'requiredtime', 'protection',
+            'timecreated', 'timemodified'));
+
+        // The issues.
+        $issues = new backup_nested_element('issues');
+        $issue = new backup_nested_element('issue', array('id'), array(
+            'customcertid', 'userid', 'timecreated', 'code'));
+
+        // The pages.
+        $pages = new backup_nested_element('pages');
+        $page = new backup_nested_element('page', array('id'), array(
+            'customcertid', 'orientation', 'width', 'height', 'pagenumber',
+            'timecreated', 'timemodified'));
+
+        // The elements.
+        $element = new backup_nested_element('element', array('id'), array(
+            'pageid', 'name', 'element', 'data', 'font', 'size', 'colour',
+            'posx', 'posy', 'sequence', 'timecreated', 'timemodified'));
+
+        // Build the tree.
+        $customcert->add_child($issues);
+        $issues->add_child($issue);
+        $customcert->add_child($pages);
+        $pages->add_child($page);
+        $page->add_child($element);
+
+        // Define sources.
+        $customcert->set_source_table('customcert', array('id' => backup::VAR_ACTIVITYID));
+
+        // Define page source.
+        $page->set_source_table('customcert_pages', array('customcertid' => backup::VAR_ACTIVITYID));
+
+        // Define element source, each element belongs to a page.
+        $element->set_source_table('customcert_elements', array('pageid' => backup::VAR_PARENTID));
+
+        // If we are including user info then save the issues.
+        if ($this->get_setting_value('userinfo')) {
+            $issue->set_source_table('customcert_issues', array('customcertid' => backup::VAR_ACTIVITYID));
+        }
+
+        // Annotate the user id's where required.
+        $issue->annotate_ids('user', 'userid');
+
+        // Return the root element (customcert), wrapped into standard activity structure.
+        return $this->prepare_activity_structure($customcert);
+    }
+}