MDL-35603 - Backup - Course import selector notice
[moodle.git] / backup / util / interfaces / processable.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-interfaces
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  * Interface to apply to all the classes we want to be processable by one @base_processor
27  *
28  * Any class being part of one backup/restore structure must implement this interface
29  * in order to be able to be processed by a given processor (visitor pattern)
30  *
31  * TODO: Finish phpdocs
32  */
33 interface processable {
35     /**
36      * This function will call to the corresponding processor method in other to
37      * make them perform the desired tasks.
38      */
39     public function process($processor);
40 }