--- /dev/null
+<?php
+
+// This file is part of 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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once($CFG->dirroot . '/mod/assignment/backup/moodle2/backup_assignment_stepslib.php'); // Because it exists (must)
+
+/**
+ * assignment backup task that provides all the settings and steps to perform one
+ * complete backup of the activity
+ */
+class backup_assignment_activity_task extends backup_activity_task {
+
+ /**
+ * Define (add) particular settings this activity can have
+ */
+ protected function define_my_settings() {
+ // No particular settings for this activity
+ }
+
+ /**
+ * Define (add) particular steps this activity can have
+ */
+ protected function define_my_steps() {
+ // Choice only has one structure step
+ $this->add_step(new backup_assignment_activity_structure_step('assignment_structure', 'assignment.xml'));
+ }
+
+ /**
+ * Code the transformations to perform in the activity in
+ * order to get transportable (encoded) links
+ */
+ static public function encode_content_links($content) {
+ global $CFG;
+
+ $base = preg_quote($CFG->wwwroot,"/");
+
+ // Link to the list of assignments
+ $search="/(".$base."\/mod\/assignment\/index.php\?id\=)([0-9]+)/";
+ $content= preg_replace($search, '$@ASIGNMENTINDEX*$2@$', $content);
+
+ // Link to assignment view by moduleid
+ $search="/(".$base."\/mod\/assignment\/view.php\?id\=)([0-9]+)/";
+ $content= preg_replace($search, '$@ASSIGNMENTVIEWBYID*$2@$', $content);
+
+ return $content;
+ }
+}
--- /dev/null
+<?php
+
+// This file is part of 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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Define all the backup steps that will be used by the backup_assignment_activity_task
+ */
+
+/**
+ * Define the complete assignment structure for backup, with file and id annotations
+ */
+class backup_assignment_activity_structure_step extends backup_activity_structure_step {
+
+ protected function define_structure() {
+
+ // To know if we are including userinfo
+ $userinfo = $this->get_setting_value('userinfo');
+
+ // Define each element separated
+ $assignment = new backup_nested_element('assignment', array('id'), array(
+ 'name', 'intro', 'introformat', 'assignmenttype',
+ 'resubmit', 'preventlate', 'emailteachers', 'var1',
+ 'var2', 'var3', 'var4', 'var5',
+ 'maxbytes', 'timedue', 'timeavailable', 'grade',
+ 'timemodified'));
+
+ $submissions = new backup_nested_element('submissions');
+
+ $submission = new backup_nested_element('submission', array('id'), array(
+ 'userid', 'timecreated', 'timemodified', 'numfiles',
+ 'data1', 'data2', 'grade', 'submissioncomment',
+ 'format', 'teacher', 'timemarked', 'mailed'));
+
+ // Build the tree
+
+ // Apply for 'assignment' subplugins optional stuff at assignment level (not multiple)
+ // Remember that order is important, try moving this line to the end and compare XML
+ $this->add_subplugin_structure('assignment', $assignment, false);
+
+ $assignment->add_child($submissions);
+ $submissions->add_child($submission);
+
+ // Apply for 'assignment' subplugins optional stuff at submission level (not multiple)
+ $this->add_subplugin_structure('assignment', $submission, false);
+
+ // Define sources
+ $assignment->set_source_table('assignment', array('id' => backup::VAR_ACTIVITYID));
+
+ // All the rest of elements only happen if we are including user info
+ if ($userinfo) {
+ $submission->set_source_table('assignment_submissions', array('assignment' => backup::VAR_PARENTID));
+ }
+
+ // Define id annotations
+ $assignment->annotate_ids('scale', 'grade');
+ $submission->annotate_ids('user', 'userid');
+ $submission->annotate_ids('user', 'teacher');
+
+ // Define file annotations
+ $assignment->annotate_files(array('assignment_intro'), null); // This file area hasn't itemid
+ $submission->annotate_files(array('assignment_submission'), 'id');
+
+ // Return the root element (assignment), wrapped into standard activity structure
+ return $this->prepare_activity_structure($assignment);
+ }
+}
case FEATURE_GRADE_HAS_GRADE: return true;
case FEATURE_GRADE_OUTCOMES: return true;
case FEATURE_GRADE_HAS_GRADE: return true;
+ case FEATURE_BACKUP_MOODLE2: return true;
default: return null;
}
--- /dev/null
+<?php
+
+// This file is part of 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/>.
+
+/**
+ * @package moodlecore
+ * @subpackage backup-moodle2
+ * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * backup subplugin class that provides the necessary information
+ * needed to backup one assignment->offline subplugin.
+ *
+ * Note: Offline assignments really haven't any special subplugin
+ * information to backup/restore, hence code below is skipped (return false)
+ * but it's a good example of sublugins supported at different
+ * elements (assignment and submission) and conditions
+ */
+class backup_assignment_offline_subplugin extends backup_subplugin {
+
+ /**
+ * Returns the subplugin information to attach at assignment element
+ */
+ protected function define_assignment_subplugin_structure($connectionpoint) {
+
+ return false; // This subplugin backup is only one example. Skip it.
+
+ /**
+ * Any activity sublugins is always rooted by one backup_subplugin_element()
+ * Those elements have some unique characteristics:
+ * - They are, basically, backup_nested_elements
+ * - They cannot have attributes
+ * - They don't have XML representations (only their final/child elements have
+ * - They are able to specify one condition in order to decide if the subplugin
+ * must be processed or no (usually we'll put the "type" condition here, but some
+ * activities, may prefer not to use any condition, see workshop)
+ */
+
+ /**
+ * Here we are defining the information that will be attached, within the "assignment" element
+ * when assignments of type "offline" are sent to backup, so we define the backup_subplugin_element
+ * as not having any final element (null) and with the condition of the '/assignment/assignmenttype'
+ * being 'offline' (that will be checked on execution)
+ *
+ * Note that, while, we allow direct "injection" of final_elements at the "assignment" level (without
+ * any nesting, we ususally pass 'null', and later enclose the real subplugin information into deeper
+ * levels (get_recommended_name() and 'config' in the example below). That will make things
+ * on restore easier, as far as subplugin information will be clearly separted from module information.
+ */
+ $subplugin = $this->get_subplugin_element($connectionpoint, null, '/assignment/assignmenttype', 'offline');
+
+ /**
+ * Here we define the real structure the subplugin is going to generate - see note above. Obviously the
+ * example below hasn't sense at all, we are exporting the whole config table that is 100% unrelated
+ * with assignments. Take it as just one example. The only important bit is that it's highly recommened to
+ * use some exclusive name in the main nested element (something that won't conflict with other subplugins/parts).
+ * So we are using 'assignment_assignment_offline' as name here (the type of the subplugin, the name of the
+ * subplugin and the name of the connection point). get_recommended_name() will help, in any case ;-)
+ *
+ * All the code below is 100% standard backup structure code, so you define the structure, the sources,
+ * annotations... whatever you need
+ */
+ $assassoff = new backup_nested_element($this->get_recommended_name($connectionpoint));
+ $config = new backup_nested_element('config', null, array('name', 'value'));
+
+ $subplugin->add_child($assassoff);
+ $assassoff->add_child($config);
+
+ $config->set_source_table('config', array());
+
+ return $subplugin; // And we return the root subplugin element
+ }
+
+ /**
+ * Returns the subplugin information to attach at submission element
+ */
+ protected function define_submission_subplugin_structure($connectionpoint) {
+
+ return false; // This subplugin backup is only one example. Skip it.
+
+ // remember this has not XML representation
+ $subplugin = $this->get_subplugin_element($connectionpoint, null, '/assignment/assignmenttype', 'offline');
+
+ // type of the subplugin, name of the subplugin and name of the connection point (recommended)
+ $asssuboff = new backup_nested_element($this->get_recommended_name($connectionpoint));
+ // Why 'submission_config' name? Because it must be unique in the hierharchy and we
+ // already are using 'config' above withing the same file
+ $config = new backup_nested_element('submission_config', null, array('name', 'value'));
+
+ $subplugin->add_child($asssuboff);
+ $asssuboff->add_child($config);
+
+ $config->set_source_table('config', array());
+
+ return $subplugin; // And we return the root subplugin element
+ }
+}