| Commit | Line | Data |
|---|---|---|
| 060df4c8 EL |
1 | <?php |
| 2 | ||
| 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/>. | |
| 17 | ||
| 18 | /** | |
| 19 | * @package moodlecore | |
| 20 | * @subpackage backup-moodle2 | |
| 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 | */ | |
| 24 | ||
| 25 | /** | |
| 26 | * Class implementing the subplugins support for moodle2 backups | |
| 27 | * | |
| 28 | * TODO: Finish phpdocs | |
| 29 | */ | |
| 30 | abstract class backup_subplugin { | |
| 31 | ||
| 32 | protected $subplugintype; | |
| 33 | protected $subpluginname; | |
| 34 | ||
| 35 | public function __construct($subplugintype, $subpluginname) { | |
| 36 | $this->subplugintype = $subplugintype; | |
| 37 | $this->subpluginname = $subpluginname; | |
| 38 | } | |
| 39 | ||
| 40 | public function define_subplugin_structure($connectionpoint) { | |
| 41 | ||
| 42 | $methodname = 'define_' . $connectionpoint . '_subplugin_structure'; | |
| 43 | ||
| 44 | if (method_exists($this, $methodname)) { | |
| 45 | return $this->$methodname($connectionpoint); | |
| 46 | } | |
| 47 | ||
| 48 | return false; | |
| 49 | } | |
| 50 | ||
| 51 | /** | |
| 52 | * Factory method that will return one backup_subplugin_element (backup_optigroup_element) | |
| 53 | * with its name automatically calculated, based one the subplugin being handled (type, name) | |
| 54 | */ | |
| 55 | protected function get_subplugin_element($connectionpoint, $final_elements = null, $conditionparam = null, $conditionvalue = null) { | |
| 56 | // Something exclusive for this backup_subplugin_element (backup_optigroup_element) | |
| 57 | // because it hasn't XML representation | |
| 58 | $name = 'optigroup_' . $this->subplugintype . '_' . $this->subpluginname . '_' . $connectionpoint; | |
| 59 | return new backup_subplugin_element($name, $final_elements, $conditionparam, $conditionvalue); | |
| 60 | } | |
| 61 | ||
| 62 | /** | |
| 63 | * Simple helper function that suggests one name for the main nested element in subplugins | |
| 64 | * It's not mandatory to use it but recommended ;-) | |
| 65 | */ | |
| 66 | protected function get_recommended_name($connectionpoint) { | |
| 67 | return 'subplugin_' . $this->subplugintype . '_' . $this->subpluginname . '_' . $connectionpoint; | |
| 68 | } | |
| 69 | ||
| 70 | } |
