MDL-50310 glossary: Fix restore of random glossary entry block
[moodle.git] / blocks / glossary_random / backup / moodle2 / restore_glossary_random_block_task.class.php
CommitLineData
f79e0753 1<?php
f79e0753
EL
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
f25a6839 18 * @package block_glossary_random
f79e0753
EL
19 * @subpackage backup-moodle2
20 * @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
21 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22 */
23
24/**
25 * Specialised restore task for the glossary_random block
26 * (using execute_after_tasks for recoding of glossaryid)
27 *
28 * TODO: Finish phpdocs
29 */
30class restore_glossary_random_block_task extends restore_block_task {
31
32 protected function define_my_settings() {
33 }
34
35 protected function define_my_steps() {
36 }
37
38 public function get_fileareas() {
39 return array(); // No associated fileareas
40 }
41
42 public function get_configdata_encoded_attributes() {
43 return array(); // No special handling of configdata
44 }
45
46 /**
47 * This function, executed after all the tasks in the plan
48 * have been executed, will perform the recode of the
49 * target glossary for the block. This must be done here
50 * and not in normal execution steps because the glossary
51 * may be restored after the block.
52 */
53 public function after_restore() {
54 global $DB;
55
56 // Get the blockid
57 $blockid = $this->get_blockid();
58
59 // Extract block configdata and update it to point to the new glossary
60 if ($configdata = $DB->get_field('block_instances', 'configdata', array('id' => $blockid))) {
61 $config = unserialize(base64_decode($configdata));
62 if (!empty($config->glossary)) {
63 // Get glossary mapping and replace it in config
64 if ($glossarymap = restore_dbops::get_backup_ids_record($this->get_restoreid(), 'glossary', $config->glossary)) {
32fc1a69
DM
65 $mappedglossary = $DB->get_record('glossary', array('id' => $glossarymap->newitemid),
66 'id,course,globalglossary', MUST_EXIST);
67 $config->glossary = $mappedglossary->id;
68 $config->courseid = $mappedglossary->course;
69 $config->globalglossary = $mappedglossary->globalglossary;
f79e0753
EL
70 $configdata = base64_encode(serialize($config));
71 $DB->set_field('block_instances', 'configdata', $configdata, array('id' => $blockid));
32fc1a69
DM
72 } else {
73 // The block refers to a glossary not present in the backup file.
74 $DB->set_field('block_instances', 'configdata', '', array('id' => $blockid));
f79e0753
EL
75 }
76 }
77 }
78 }
79
80 static public function define_decode_contents() {
81 return array();
82 }
83
84 static public function define_decode_rules() {
85 return array();
86 }
87}