MDL-22234 backup - implement choice backup (used for backup tutorial)

mod/choice/backup/moodle2/backup_choice_activity_task.class.php

@@ -0,0 +1,68 @@
+<?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/choice/backup/moodle2/backup_choice_stepslib.php'); // Because it exists (must)
+require_once($CFG->dirroot . '/mod/choice/backup/moodle2/backup_choice_settingslib.php'); // Because it exists (optional)
+
+/**
+ * choice backup task that provides all the settings and steps to perform one
+ * complete backup of the activity
+ */
+class backup_choice_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_choice_activity_structure_step('choice_structure', 'choice.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 choices
+        $search="/(".$base."\/mod\/choice\/index.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@CHOICEINDEX*$2@$', $content);
+
+        // Link to choice view by moduleid
+        $search="/(".$base."\/mod\/choice\/view.php\?id\=)([0-9]+)/";
+        $content= preg_replace($search, '$@CHOICEVIEWBYID*$2@$', $content);
+
+        return $content;
+    }
+}

mod/choice/backup/moodle2/backup_choice_settingslib.php

@@ -0,0 +1,27 @@
+<?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
+ */
+
+ // This activity has not particular settings but the inherited from the generic
+ // backup_activity_task so here there isn't any class definition, like the ones
+ // existing in /backup/moodle2/backup_settingslib.php (activities section)

mod/choice/backup/moodle2/backup_choice_stepslib.php

@@ -0,0 +1,85 @@
+<?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_choice_activity_task
+ */
+
+/**
+ * Define the complete choice structure for backup, with file and id annotations
+ */
+class backup_choice_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
+        $choice = new backup_nested_element('choice', array('id'), array(
+            'name', 'intro', 'introformat', 'publish',
+            'showresults', 'display', 'allowupdate', 'allowunanswered',
+            'limitanswers', 'timeopen', 'timeclose', 'timemodified'));
+
+        $options = new backup_nested_element('options');
+
+        $option = new backup_nested_element('option', array('id'), array(
+            'text', 'maxanswers', 'timemodified'));
+
+        $answers = new backup_nested_element('answers');
+
+        $answer = new backup_nested_element('answer', array('id'), array(
+            'userid', 'optionid', 'timemodified'));
+
+        // Build the tree
+        $choice->add_child($options);
+        $options->add_child($option);
+
+        $choice->add_child($answers);
+        $answers->add_child($answer);
+
+        // Define sources
+        $choice->set_source_table('choice', array('id' => backup::VAR_ACTIVITYID));
+
+        $option->set_source_sql('
+            SELECT *
+              FROM {choice_options}
+             WHERE choiceid = ?',
+            array(backup::VAR_PARENTID));
+
+        // All the rest of elements only happen if we are including user info
+        if ($userinfo) {
+            $answer->set_source_table('choice_answers', array('choiceid' => '../../id'));
+        }
+
+        // Define id annotations
+        $answer->annotate_ids('user', 'userid');
+
+        // Define file annotations
+        $choice->annotate_files(array('choice_intro'), null); // This file area hasn't itemid
+
+        // Return the root element (choice), wrapped into standard activity structure
+        return $this->prepare_activity_structure($choice);
+    }
+}

mod/choice/lib.php

@@ -916,6 +916,7 @@ function choice_supports($feature) {
         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
         case FEATURE_GRADE_HAS_GRADE:         return false;
         case FEATURE_GRADE_OUTCOMES:          return false;
+        case FEATURE_BACKUP_MOODLE2:          return true;
 
         default: return null;
     }
@@ -949,4 +950,4 @@ function choice_extend_settings_navigation(settings_navigation $settings, naviga
         }
         $choicenode->add(get_string("viewallresponses", "choice", $responsecount), new moodle_url('/mod/choice/report.php', array('id'=>$PAGE->cm->id)));
     }
-}
+}