You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
2.0 KiB
62 lines
2.0 KiB
2 years ago
|
<?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/>.
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Web services API documentation
|
||
|
|
*
|
||
|
|
* @package webservice
|
||
|
|
* @copyright 2011 Moodle Pty Ltd (http://moodle.com)
|
||
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||
|
|
* @author Jerome Mouneyrac
|
||
|
|
*/
|
||
|
|
require_once('../../config.php');
|
||
|
|
require_once($CFG->libdir . '/adminlib.php');
|
||
|
|
require($CFG->dirroot . '/webservice/lib.php');
|
||
|
|
|
||
|
|
admin_externalpage_setup('webservicedocumentation');
|
||
|
|
|
||
|
|
// get all the function descriptions
|
||
|
|
$functions = $DB->get_records('external_functions', array(), 'name');
|
||
|
|
$functiondescs = array();
|
||
|
|
foreach ($functions as $function) {
|
||
|
|
$functiondescs[$function->name] = external_api::external_function_info($function);
|
||
|
|
}
|
||
|
|
|
||
|
|
//display the documentation for all documented protocols,
|
||
|
|
//regardless if they are activated or not
|
||
|
|
$protocols = array();
|
||
|
|
$protocols['rest'] = true;
|
||
|
|
$protocols['xmlrpc'] = true;
|
||
|
|
|
||
|
|
/// Check if we are in printable mode
|
||
|
|
$printableformat = optional_param('print', false, PARAM_BOOL);
|
||
|
|
|
||
|
|
/// OUTPUT
|
||
|
|
echo $OUTPUT->header();
|
||
|
|
|
||
|
|
$renderer = $PAGE->get_renderer('core', 'webservice');
|
||
|
|
echo $renderer->documentation_html($functiondescs,
|
||
|
|
$printableformat, $protocols, array(), $PAGE->url);
|
||
|
|
|
||
|
|
/// trigger browser print operation
|
||
|
|
if (!empty($printableformat)) {
|
||
|
|
$PAGE->requires->js_function_call('window.print', array());
|
||
|
|
}
|
||
|
|
|
||
|
|
echo $OUTPUT->footer();
|
||
|
|
|