backup/moodle2/backup_format_plugin.class.php

   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  * Defines backup_format_plugin class
  20  *
  21  * @package     core_backup
  22  * @subpackage  moodle2
  23  * @category    backup
  24  * @copyright   2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 defined('MOODLE_INTERNAL') || die();
  29
  30 /**
  31  * Class extending standard backup_plugin in order to implement some
  32  * helper methods related with the course formats (format plugin)
  33  *
  34  * TODO: Finish phpdocs
  35  */
  36 abstract class backup_format_plugin extends backup_plugin {
  37
  38     protected $courseformat; // To store the format (course->format) of the instance
  39
  40     public function __construct($plugintype, $pluginname, $optigroup, $step) {
  41
  42         parent::__construct($plugintype, $pluginname, $optigroup, $step);
  43
  44         $this->courseformat = backup_plan_dbops::get_courseformat_from_courseid($this->task->get_courseid());
  45
  46     }
  47
  48     /**
  49      * Return the condition encapsulated into sqlparam format
  50      * to get evaluated by value, not by path nor processor setting
  51      */
  52     protected function get_format_condition() {
  53         return array('sqlparam' => $this->courseformat);
  54     }
  55 }