MDL-21432 backup 2.0 - initial commit. util dir

2010-04-21 09:17:06 +00:00
parent afef965e28
commit 69dd0c8cbf
77 changed files with 10837 additions and 0 deletions
@@ -0,0 +1,41 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @package    moodlecore
+ * @subpackage backup-interfaces
+ * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Interface to apply to all the classes we want to be annotable in the backup/restore process
+ *
+ * TODO: Finish phpdocs
+ */
+interface annotable {
+
+    /**
+     * This function implements the annotation of the current value associating it with $itemname
+     */
+    public function annotate($backupid);
+
+    /**
+     * This function sets the $itemname to be used when annotating
+     */
+    public function set_annotation_item($itemname);
+}