first commit

backup/util/interfaces/annotable.class.php

@@ -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);
+}

backup/util/interfaces/checksumable.class.php

@@ -0,0 +1,49 @@
+<?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 calculate their checksum
+ *
+ * Each class being part of @backup_controller will implement this interface
+ * in order to be able to calculate one objective and unique checksum for
+ * the whole controller class.
+ *
+ * TODO: Finish phpdocs
+ */
+interface checksumable {
+
+    /**
+     * This function will return one unique and stable checksum for one instance
+     * of the class implementing it. It's each implementation responsibility to
+     * do it recursively if needed and use optional store (caching) of the checksum if
+     * necessary/possible
+     */
+    public function calculate_checksum();
+
+    /**
+     * Given one checksum, returns if matches object's checksum (true) or no (false)
+     */
+    public function is_checksum_correct($checksum);
+
+}

backup/util/interfaces/executable.class.php

@@ -0,0 +1,37 @@
+<?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 executable (plan/part/task)
+ *
+ * TODO: Finish phpdocs
+ */
+interface executable {
+
+    /**
+     * This function will perform all the actions necessary to achieve the execution
+     * of the plan/part/task
+     */
+    public function execute();
+}

backup/util/interfaces/loggable.class.php

@@ -0,0 +1,42 @@
+<?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 able to write to logs
+ *
+ * Any class being part of one backup/restore and needing to senf informatio
+ * to logs must implement this interface (and have access to the @logger
+ * instantiated object)
+ *
+ * TODO: Finish phpdocs
+ */
+interface loggable {
+
+    /**
+     * This function will be responsible for handling the params, and to call
+     * to the corresponding logger->process() once all modifications in params
+     * have been performed
+     */
+    public function log($message, $level, $a = null, $depth = null, $display = false);
+}

backup/util/interfaces/processable.class.php

@@ -0,0 +1,40 @@
+<?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 processable by one @base_processor
+ *
+ * Any class being part of one backup/restore structure must implement this interface
+ * in order to be able to be processed by a given processor (visitor pattern)
+ *
+ * TODO: Finish phpdocs
+ */
+interface processable {
+
+    /**
+     * This function will call to the corresponding processor method in other to
+     * make them perform the desired tasks.
+     */
+    public function process($processor);
+}