Current Path : C:/Users/Mahmood/Desktop/moodle/backup/moodle2/ |
Current File : C:/Users/Mahmood/Desktop/moodle/backup/moodle2/backup_subplugin.class.php |
<?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/>. /** * Defines backup_subplugin class * @package core_backup * @subpackage moodle2 * @category backup * @copyright 2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com} * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); /** * Class implementing the subplugins support for moodle2 backups * * TODO: Finish phpdocs * TODO: Make this subclass of backup_plugin */ abstract class backup_subplugin { protected $subplugintype; protected $subpluginname; protected $connectionpoint; protected $optigroup; // Optigroup, parent of all optigroup elements protected $step; protected $task; public function __construct($subplugintype, $subpluginname, $optigroup, $step) { $this->subplugintype = $subplugintype; $this->subpluginname = $subpluginname; $this->optigroup = $optigroup; $this->connectionpoint = ''; $this->step = $step; $this->task = $step->get_task(); } public function define_subplugin_structure($connectionpoint) { $this->connectionpoint = $connectionpoint; $methodname = 'define_' . $connectionpoint . '_subplugin_structure'; if (method_exists($this, $methodname)) { $this->$methodname(); } } // Protected API starts here // backup_step/structure_step/task wrappers /** * Returns the value of one (task/plan) setting */ protected function get_setting_value($name) { if (is_null($this->task)) { throw new backup_step_exception('not_specified_backup_task'); } return $this->task->get_setting_value($name); } // end of backup_step/structure_step/task wrappers /** * Factory method that will return one backup_subplugin_element (backup_optigroup_element) * with its name automatically calculated, based one the subplugin being handled (type, name) */ protected function get_subplugin_element($final_elements = null, $conditionparam = null, $conditionvalue = null) { // Something exclusive for this backup_subplugin_element (backup_optigroup_element) // because it hasn't XML representation $name = 'optigroup_' . $this->subplugintype . '_' . $this->subpluginname . '_' . $this->connectionpoint; $optigroup_element = new backup_subplugin_element($name, $final_elements, $conditionparam, $conditionvalue); $this->optigroup->add_child($optigroup_element); // Add optigroup_element to stay connected since beginning return $optigroup_element; } /** * Simple helper function that suggests one name for the main nested element in subplugins * It's not mandatory to use it but recommended ;-) */ protected function get_recommended_name() { return 'subplugin_' . $this->subplugintype . '_' . $this->subpluginname . '_' . $this->connectionpoint; } }