Russell Smith
1fcf0ca8a5
dirname() is a slow function compared with __DIR__ and using '/../'. Moodle has a large number of legacy files that are included each time a page loads and is not able to use an autoloader as it is functional code. This allows those required includes to perform as best as possible in this situation.
109 lines
3.3 KiB
PHP
109 lines
3.3 KiB
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/>.
|
|
|
|
/**
|
|
* @package tool_xmldb
|
|
* @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
/**
|
|
* This class will produce XSL documentation for the loaded XML file
|
|
*
|
|
* @package tool_xmldb
|
|
* @copyright 2003 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class generate_documentation extends XMLDBAction {
|
|
|
|
/**
|
|
* Init method, every subclass will have its own
|
|
*/
|
|
function init() {
|
|
parent::init();
|
|
|
|
// Set own custom attributes
|
|
$this->sesskey_protected = false; // This action doesn't need sesskey protection
|
|
|
|
// Get needed strings
|
|
$this->loadStrings(array(
|
|
'backtomainview' => 'tool_xmldb',
|
|
'documentationintro' => 'tool_xmldb'
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Invoke method, every class will have its own
|
|
* returns true/false on completion, setting both
|
|
* errormsg and output as necessary
|
|
*/
|
|
function invoke() {
|
|
parent::invoke();
|
|
|
|
$result = true;
|
|
|
|
// Set own core attributes
|
|
$this->does_generate = ACTION_GENERATE_HTML;
|
|
|
|
// These are always here
|
|
global $CFG, $XMLDB;
|
|
|
|
// Do the job, setting $result as needed
|
|
|
|
// Get the dir containing the file
|
|
$dirpath = required_param('dir', PARAM_PATH);
|
|
$dirpath = $CFG->dirroot . $dirpath;
|
|
$path = $dirpath.'/install.xml';
|
|
if(!file_exists($path) || !is_readable($path)) {
|
|
return false;
|
|
}
|
|
|
|
// Add link back to home
|
|
$b = ' <p class="centerpara buttons">';
|
|
$b .= ' <a href="index.php?action=main_view#lastused">[' . $this->str['backtomainview'] . ']</a>';
|
|
$b .= '</p>';
|
|
$this->output=$b;
|
|
|
|
$c = ' <p class="centerpara">';
|
|
$c .= $this->str['documentationintro'];
|
|
$c .= '</p>';
|
|
$this->output.=$c;
|
|
|
|
if(class_exists('XSLTProcessor')) {
|
|
// Transform XML file and display it
|
|
$doc = new DOMDocument();
|
|
$xsl = new XSLTProcessor();
|
|
|
|
$doc->load(__DIR__.'/xmldb.xsl');
|
|
$xsl->importStyleSheet($doc);
|
|
|
|
$doc->load($path);
|
|
$this->output.=$xsl->transformToXML($doc);
|
|
$this->output.=$b;
|
|
} else {
|
|
$this->output.=get_string('extensionrequired','tool_xmldb','xsl');
|
|
}
|
|
|
|
// Launch postaction if exists (leave this unmodified)
|
|
if ($this->getPostAction() && $result) {
|
|
return $this->launch($this->getPostAction());
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
}
|
|
|