e3f0ed0c89cb97db4a1d4ba9bcaee372fa47112f
[moodle.git] / lib / dtl / database_mover.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/>.
19 /**
20  * General database mover class
21  *
22  * @package    core
23  * @subpackage dtl
24  * @copyright  2008 Andrei Bautu
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 class database_mover extends database_exporter {
31     /** Importer object used to transfer data. */
32     protected $importer;
33     protected $feeback;
35     /**
36      * Object constructor.
37      *
38      * @param moodle_database $mdb Connection to the source database (a
39      * @see moodle_database object).
40      * @param moodle_database $mdb_target Connection to the target database (a
41      * @see moodle_database object).
42      * @param boolean $check_schema - whether or not to check that XML database
43      * schema matches the RDBMS database schema before exporting (used by
44      * @see export_database).
45      */
46     public function __construct(moodle_database $mdb_source, moodle_database $mdb_target,
47             $check_schema = true, progress_trace $feeback = null) {
48         if (empty($feeback)) {
49             $this->feeback = new null_progress_trace();
50         } else {
51             $this->feeback = $feeback;
52         }
53         if ($check_schema) {
54             $this->feeback->output(get_string('checkingsourcetables', 'dbtransfer'));
55         }
56         parent::__construct($mdb_source, $check_schema);
57         $this->feeback->output(get_string('creatingtargettables', 'dbtransfer'));
58         $this->importer = new database_importer($mdb_target, $check_schema);
59     }
61     /**
62      * How to use transactions during the transfer.
63      * @param string $mode 'pertable', 'allinone' or 'none'.
64      */
65     public function set_transaction_mode($mode) {
66         $this->importer->set_transaction_mode($mode);
67     }
69     /**
70      * Callback function. Calls importer's begin_database_import callback method.
71      *
72      * @param float $version the version of the system which generating the data
73      * @param string $timestamp the timestamp of the data (in ISO 8601) format.
74      * @param string $description a user description of the data.
75      * @return void
76      */
77     public function begin_database_export($version, $release, $timestamp, $description) {
78         $this->feeback->output(get_string('copyingtables', 'dbtransfer'));
79         $this->importer->begin_database_import($version, $timestamp, $description);
80     }
82     /**
83      * Callback function. Calls importer's begin_table_import callback method.
84      *
85      * @param xmldb_table $table - XMLDB object for the exported table
86      * @return void
87      */
88     public function begin_table_export(xmldb_table $table) {
89         $this->feeback->output(get_string('copyingtable', 'dbtransfer', $table->getName()), 1);
90         $this->importer->begin_table_import($table->getName(), $table->getHash());
91     }
93     /**
94      * Callback function. Calls importer's import_table_data callback method.
95      *
96      * @param xmldb_table $table - XMLDB object of the table from which data
97      * was retrieved
98      * @param object $data - data object (fields and values from record)
99      * @return void
100      */
101     public function export_table_data(xmldb_table $table, $data) {
102         $this->importer->import_table_data($table->getName(), $data);
103     }
105     /**
106      * Callback function. Calls importer's finish_table_import callback method.
107      * @param xmldb_table $table - XMLDB object for the exported table
108      * @return void
109      */
110     public function finish_table_export(xmldb_table $table) {
111         $this->feeback->output(get_string('done', 'dbtransfer', $table->getName()), 2);
112         $this->importer->finish_table_import($table->getName());
113     }
115     /**
116      * Callback function. Calls importer's finish_database_import callback method.
117      * @return void
118      */
119     public function finish_database_export() {
120         $this->importer->finish_database_import();
121     }