MDL-21432 backup 2.0 - initial commit. util dir
[moodle.git] / backup / util / interfaces / annotable.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 annotable in the backup/restore process
27  *
28  * TODO: Finish phpdocs
29  */
30 interface annotable {
32     /**
33      * This function implements the annotation of the current value associating it with $itemname
34      */
35     public function annotate($backupid);
37     /**
38      * This function sets the $itemname to be used when annotating
39      */
40     public function set_annotation_item($itemname);
41 }