[Summary 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 display the XML for one structure
  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 view_structure_xml 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_GENERATE_XML;
  59  
  60          // These are always here
  61          global $CFG, $XMLDB;
  62  
  63          // Do the job, setting result as needed
  64  
  65          // Get the file parameter
  66          $select = required_param('select', PARAM_ALPHA); //original/edited
  67          // Get the dir containing the file
  68          $dirpath = required_param('dir', PARAM_PATH);
  69          $dirpath = $CFG->dirroot . $dirpath;
  70  
  71          // Get the correct dir
  72          if ($select == 'original') {
  73              if (!empty($XMLDB->dbdirs)) {
  74                  $base = $XMLDB->dbdirs[$dirpath];
  75              }
  76          } else if ($select == 'edited') {
  77              if (!empty($XMLDB->editeddirs)) {
  78                  $base = $XMLDB->editeddirs[$dirpath];
  79              }
  80          } else {
  81              $this->errormsg = 'Cannot access to ' . $select . ' info';
  82              $result = false;
  83          }
  84          if ($base) {
  85              // Only if the directory exists and it has been loaded
  86              if (!$base->path_exists || !$base->xml_loaded) {
  87                  $this->errormsg = 'Directory ' . $dirpath . ' not loaded';
  88                  return false;
  89              }
  90          } else {
  91              $this->errormsg = 'Problem handling ' . $select . ' files';
  92              return false;
  93          }
  94  
  95          // Get the structure
  96          if ($result) {
  97              if (!$structure = $base->xml_file->getStructure()) {
  98                  $this->errormsg = 'Error retrieving ' . $select . ' structure';
  99                  $result = false;
 100              }
 101          }
 102  
 103          if ($result) {
 104              // Everything is ok. Generate the XML output
 105              $this->output = $structure->xmlOutput();
 106          } else {
 107              // Switch to HTML and error
 108              $this->does_generate = ACTION_GENERATE_HTML;
 109          }
 110  
 111          // Return ok if arrived here
 112          return $result;
 113      }
 114  }
 115