71b90dd97a4e3ee617f6238aba5cac16d6d9c82c
[moodle.git] / backup / util / ui / base_ui_stage.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  * Backup user interface stages
20  *
21  * This file contains the classes required to manage the stages that make up the
22  * backup user interface.
23  * These will be primarily operated a {@see backup_ui} instance.
24  *
25  * @package   moodlecore
26  * @copyright 2010 Sam Hemelryk
27  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 /**
31  * Abstract stage class
32  *
33  * This class should be extended by all backup stages (a requirement of many backup ui functions).
34  * Each stage must then define two abstract methods
35  *  - process : To process the stage
36  *  - initialise_stage_form : To get a backup_moodleform instance for the stage
37  *
38  * @copyright 2010 Sam Hemelryk
39  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 abstract class base_ui_stage {
42     /**
43      * The current stage
44      * @var int
45      */
46     protected $stage = 1;
47     /**
48      * The backuck UI object
49      * @var base_ui
50      */
51     protected $ui;
52     /**
53      * The moodleform for this stage
54      * @var base_moodleform
55      */
56     protected $stageform = null;
57     /**
58      * Custom form params that will be added as hidden inputs
59      */
60     protected $params = null;
61     /**
62      *
63      * @param base_ui $ui
64      */
65     public function __construct(base_ui $ui, array $params=null) {
66         $this->ui = $ui;
67         $this->params = $params;
68     }
69     /**
70      * Returns the custom params for this stage
71      * @return array|null
72      */
73     final public function get_params() {
74         return $this->params;
75     }
76     /**
77      * The current stage
78      * @return int
79      */
80     final public function get_stage() {
81         return $this->stage;
82     }
83     /**
84      * The next stage
85      * @return int
86      */
87     final public function get_next_stage() {
88         return floor($this->stage*2);
89     }
90     /**
91      * The previous stage
92      * @return int
93      */
94     final public function get_prev_stage() {
95         return floor($this->stage/2);
96     }
97     /**
98      * The name of this stage
99      * @return string
100      */
101     public function get_name() {
102         return get_string('currentstage'.$this->stage,'backup');
103     }
104     /**
105      * The backup id from the backup controller
106      * @return string
107      */
108     final public function get_uniqueid() {
109         return $this->ui->get_uniqueid();
110     }
112     /**
113      * Displays the stage.
114      *
115      * By default this involves instantiating the form for the stage and the calling
116      * it to display.
117      *
118      * @param core_backup_renderer $renderer
119      * @return string HTML code to echo
120      */
121     public function display(core_backup_renderer $renderer) {
123         $form = $this->initialise_stage_form();
124         // a nasty hack follows to work around the sad fact that moodle quickforms
125         // do not allow to actually return the HTML content, just to echo it
126         flush();
127         ob_start();
128         $form->display();
129         $output = ob_get_contents();
130         ob_end_clean();
132         return $output;
133     }
135     /**
136      * Processes the stage.
137      *
138      * This must be overridden by every stage as it will be different for every stage
139      *
140      * @abstract
141      * @param backup_moodleform|null $form
142      */
143     abstract public function process(base_moodleform $form=null);
144     /**
145      * Creates an instance of the correct moodleform properly populated and all
146      * dependencies instantiated
147      *
148      * @abstract
149      * @return backup_moodleform
150      */
151     abstract protected function initialise_stage_form();
153     final public function get_ui() {
154         return $this->ui;
155     }
157     public function is_first_stage() {
158         return $this->stage == 1;
159     }