b08065ef33ca10b909e04a9246246e6da3e72d01
[moodle.git] / backup / util / checks / restore_check.class.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    moodlecore
20  * @subpackage backup-factories
21  * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Non instantiable helper class providing different restore checks
27  *
28  * This class contains various static methods available in order to easily
29  * perform a bunch of restore architecture tests
30  *
31  * TODO: Finish phpdocs
32  */
33 abstract class restore_check {
35     public static function check_courseid($courseid) {
36         global $DB;
37         // id must exist in course table
38         if (! $DB->record_exists('course', array('id' => $courseid))) {
39             throw new restore_controller_exception('restore_check_course_not_exists', $courseid);
40         }
41         return true;
42     }
44     public static function check_user($userid) {
45         global $DB;
46         // userid must exist in user table
47         if (! $DB->record_exists('user', array('id' => $userid))) {
48             throw new restore_controller_exception('restore_check_user_not_exists', $userid);
49         }
50         return true;
51     }
53     public static function check_security($restore_controller, $apply) {
55         debugging('TODO: Not applying security yet!', DEBUG_DEVELOPER); // TODO: Add once plan is complete
56         return true;
57     }
58 }