[Summary view] [Print] [Text view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * @package    tool_xmldb
  19   * @copyright  2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  20   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  21   */
  22  
  23  /**
  24   * This class will unload one loaded file completely
  25   *
  26   * @package    tool_xmldb
  27   * @copyright  2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  28   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  class unload_xml_file extends XMLDBAction {
  31  
  32      /**
  33       * Init method, every subclass will have its own
  34       */
  35      function init() {
  36          parent::init();
  37  
  38          // Set own custom attributes
  39          $this->sesskey_protected = false; // This action doesn't need sesskey protection
  40  
  41          // Get needed strings
  42          $this->loadStrings(array(
  43              // 'key' => 'module',
  44          ));
  45      }
  46  
  47      /**
  48       * Invoke method, every class will have its own
  49       * returns true/false on completion, setting both
  50       * errormsg and output as necessary
  51       */
  52      function invoke() {
  53          parent::invoke();
  54  
  55          $result = true;
  56  
  57          // Set own core attributes
  58          $this->does_generate = ACTION_NONE;
  59  
  60          // These are always here
  61          global $CFG, $XMLDB;
  62  
  63          // Do the job, setting result as needed
  64  
  65          // Get the dir containing the file
  66          $dirpath = required_param('dir', PARAM_PATH);
  67          $dirpath = $CFG->dirroot . $dirpath;
  68  
  69          // Get the original dir and delete some elements
  70          if (!empty($XMLDB->dbdirs)) {
  71              if (isset($XMLDB->dbdirs[$dirpath])) {
  72                  $dbdir = $XMLDB->dbdirs[$dirpath];
  73                  if ($dbdir) {
  74                      unset($dbdir->xml_file);
  75                      unset($dbdir->xml_loaded);
  76                      unset($dbdir->xml_changed);
  77                      unset($dbdir->xml_exists);
  78                      unset($dbdir->xml_writeable);
  79                  }
  80              }
  81          }
  82          // Get the edited dir and delete it completely
  83          if (!empty($XMLDB->editeddirs)) {
  84              if (isset($XMLDB->editeddirs[$dirpath])) {
  85                  unset($XMLDB->editeddirs[$dirpath]);
  86              }
  87          }
  88  
  89          // Launch postaction if exists (leave this here!)
  90          if ($this->getPostAction() && $result) {
  91              return $this->launch($this->getPostAction());
  92          }
  93  
  94          // Return ok if arrived here
  95          return $result;
  96      }
  97  }
  98