[Summary view]

   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-plan
  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   * Abstract class defining the needed stuf for one backup step
  27   *
  28   * TODO: Finish phpdocs
  29   */
  30  abstract class backup_step extends base_step {
  31  
  32      /**
  33       * Constructor - instantiates one object of this class
  34       */
  35      public function __construct($name, $task = null) {
  36          if (!is_null($task) && !($task instanceof backup_task)) {
  37              throw new backup_step_exception('wrong_backup_task_specified');
  38          }
  39          parent::__construct($name, $task);
  40      }
  41  
  42      protected function get_backupid() {
  43          if (is_null($this->task)) {
  44              throw new backup_step_exception('not_specified_backup_task');
  45          }
  46          return $this->task->get_backupid();
  47      }
  48  }
  49  
  50  /*
  51   * Exception class used by all the @backup_step stuff
  52   */
  53  class backup_step_exception extends base_step_exception {
  54  
  55      public function __construct($errorcode, $a=NULL, $debuginfo=null) {
  56          parent::__construct($errorcode, $a, $debuginfo);
  57      }
  58  }