moodle-mod_attendance/backup/moodle2/restore_attendance_stepslib.php

<?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/>.

/**
 * Structure step to restore one attendance activity
 *
 * @package    mod_attendance
 * @copyright  2011 Artem Andreev <andreev.artem@gmail.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

/**
 * Define all the restore steps that will be used by the restore_attendance_activity_task
 *
 * @copyright  2011 Artem Andreev <andreev.artem@gmail.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class restore_attendance_activity_structure_step extends restore_activity_structure_step {

    /**
     * Define the structure of the restore workflow.
     *
     * @return restore_path_element $structure
     */
    protected function define_structure() {

        $paths = array();

        $userinfo = $this->get_setting_value('userinfo'); // Are we including userinfo?

        // XML interesting paths - non-user data.
        $paths[] = new restore_path_element('attendance', '/activity/attendance');

        $paths[] = new restore_path_element('attendance_status',
                       '/activity/attendance/statuses/status');

        $paths[] = new restore_path_element('attendance_warning',
            '/activity/attendance/warnings/warning');

        $paths[] = new restore_path_element('attendance_session',
                       '/activity/attendance/sessions/session');

        // End here if no-user data has been selected.
        if (!$userinfo) {
            return $this->prepare_activity_structure($paths);
        }

        // XML interesting paths - user data.
        $paths[] = new restore_path_element('attendance_log',
                       '/activity/attendance/sessions/session/logs/log');

        // Return the paths wrapped into standard activity structure.
        return $this->prepare_activity_structure($paths);
    }

    /**
     * Process an attendance restore.
     *
     * @param object $data The data in object form
     * @return void
     */
    protected function process_attendance($data) {
        global $DB;

        $data = (object)$data;
        $data->course = $this->get_courseid();

        // Insert the attendance record.
        $newitemid = $DB->insert_record('attendance', $data);
        // Immediately after inserting "activity" record, call this.
        $this->apply_activity_instance($newitemid);
    }

    /**
     * Process attendance status restore
     * @param object $data The data in object form
     * @return void
     */
    protected function process_attendance_status($data) {
        global $DB;

        $data = (object)$data;
        $oldid = $data->id;

        $data->attendanceid = $this->get_new_parentid('attendance');

        $newitemid = $DB->insert_record('attendance_statuses', $data);
        $this->set_mapping('attendance_status', $oldid, $newitemid);
    }

    /**
     * Process attendance warning restore
     * @param object $data The data in object form
     * @return void
     */
    protected function process_attendance_warning($data) {
        global $DB;

        $data = (object)$data;

        $data->idnumber = $this->get_new_parentid('attendance');

        $DB->insert_record('attendance_warning', $data);
    }

    /**
     * Process attendance session restore
     * @param object $data The data in object form
     * @return void
     */
    protected function process_attendance_session($data) {
        global $DB;

        $data = (object)$data;
        $oldid = $data->id;

        $data->attendanceid = $this->get_new_parentid('attendance');
        $data->groupid = $this->get_mappingid('group', $data->groupid);
        $data->sessdate = $this->apply_date_offset($data->sessdate);
        $data->lasttaken = $this->apply_date_offset($data->lasttaken);
        $data->lasttakenby = $this->get_mappingid('user', $data->lasttakenby);
        $data->timemodified = $this->apply_date_offset($data->timemodified);
        $data->caleventid = $this->get_mappingid('event', $data->caleventid);

        $newitemid = $DB->insert_record('attendance_sessions', $data);
        $data->id = $newitemid;
        $this->set_mapping('attendance_session', $oldid, $newitemid, true);

        // Create Calendar event.
        attendance_create_calendar_event($data);
    }

    /**
     * Process attendance log restore
     * @param object $data The data in object form
     * @return void
     */
    protected function process_attendance_log($data) {
        global $DB;

        $data = (object)$data;

        $data->sessionid = $this->get_mappingid('attendance_session', $data->sessionid);
        $data->studentid = $this->get_mappingid('user', $data->studentid);
        $data->statusid = $this->get_mappingid('attendance_status', $data->statusid);
        $statusset = explode(',', $data->statusset);
        foreach ($statusset as $st) {
            $st = $this->get_mappingid('attendance_status', $st);
        }
        $data->statusset = implode(',', $statusset);
        $data->timetaken = $this->apply_date_offset($data->timetaken);
        $data->takenby = $this->get_mappingid('user', $data->takenby);

        $DB->insert_record('attendance_log', $data);
    }

    /**
     * Once the database tables have been fully restored, restore the files
     * @return void
     */
    protected function after_execute() {
        $this->add_related_files('mod_attendance', 'session', 'attendance_session');
    }
}