MDL-35603 - Backup - Course import selector notice
[moodle.git] / backup / util / interfaces / checksumable.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 calculate their checksum
27  *
28  * Each class being part of @backup_controller will implement this interface
29  * in order to be able to calculate one objective and unique checksum for
30  * the whole controller class.
31  *
32  * TODO: Finish phpdocs
33  */
34 interface checksumable {
36     /**
37      * This function will return one unique and stable checksum for one instance
38      * of the class implementing it. It's each implementation responsibility to
39      * do it recursively if needed and use optional store (caching) of the checksum if
40      * necessary/possible
41      */
42     public function calculate_checksum();
44     /**
45      * Given one checksum, returns if matches object's checksum (true) or no (false)
46      */
47     public function is_checksum_correct($checksum);
49 }