MDL-22245 backup - improving subplugin support a bit, thanks to David for his comments
[moodle.git] / backup / moodle2 / backup_subplugin.class.php
CommitLineData
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 */
30abstract class backup_subplugin {
31
32 protected $subplugintype;
33 protected $subpluginname;
4abf04ea 34 protected $connectionpoint;
060df4c8
EL
35
36 public function __construct($subplugintype, $subpluginname) {
37 $this->subplugintype = $subplugintype;
38 $this->subpluginname = $subpluginname;
4abf04ea 39 $this->connectionpoint = '';
060df4c8
EL
40 }
41
42 public function define_subplugin_structure($connectionpoint) {
43
4abf04ea
EL
44 $this->connectionpoint = $connectionpoint;
45
060df4c8
EL
46 $methodname = 'define_' . $connectionpoint . '_subplugin_structure';
47
48 if (method_exists($this, $methodname)) {
4abf04ea 49 return $this->$methodname();
060df4c8
EL
50 }
51
52 return false;
53 }
54
55 /**
56 * Factory method that will return one backup_subplugin_element (backup_optigroup_element)
57 * with its name automatically calculated, based one the subplugin being handled (type, name)
58 */
4abf04ea 59 protected function get_subplugin_element($final_elements = null, $conditionparam = null, $conditionvalue = null) {
060df4c8
EL
60 // Something exclusive for this backup_subplugin_element (backup_optigroup_element)
61 // because it hasn't XML representation
4abf04ea 62 $name = 'optigroup_' . $this->subplugintype . '_' . $this->subpluginname . '_' . $this->connectionpoint;
060df4c8
EL
63 return new backup_subplugin_element($name, $final_elements, $conditionparam, $conditionvalue);
64 }
65
66 /**
67 * Simple helper function that suggests one name for the main nested element in subplugins
68 * It's not mandatory to use it but recommended ;-)
69 */
4abf04ea
EL
70 protected function get_recommended_name() {
71 return 'subplugin_' . $this->subplugintype . '_' . $this->subpluginname . '_' . $this->connectionpoint;
060df4c8
EL
72 }
73
74}