123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838 |
- <?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 service documentation renderer.
- *
- * @package core_webservice
- * @category output
- * @copyright 2009 Jerome Mouneyrac <jerome@moodle.com>
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- class core_webservice_renderer extends plugin_renderer_base {
- /**
- * Display the authorised user selector
- *
- * @param stdClass $options It contains alloweduserselector, potentialuserselector and serviceid
- * @return string html
- */
- public function admin_authorised_user_selector(&$options) {
- global $CFG;
- $formcontent = html_writer::empty_tag('input',
- array('name' => 'sesskey', 'value' => sesskey(), 'type' => 'hidden'));
- $table = new html_table();
- $table->size = array('45%', '10%', '45%');
- $table->attributes['class'] = 'roleassigntable generaltable generalbox boxaligncenter';
- $table->summary = '';
- $table->cellspacing = 0;
- $table->cellpadding = 0;
- // LTR/RTL support, for drawing button arrows in the right direction
- if (right_to_left()) {
- $addarrow = '▶';
- $removearrow = '◀';
- } else {
- $addarrow = '◀';
- $removearrow = '▶';
- }
- //create the add and remove button
- $addinput = html_writer::empty_tag('input',
- array('name' => 'add', 'id' => 'add', 'type' => 'submit',
- 'value' => $addarrow . ' ' . get_string('add'),
- 'title' => get_string('add')));
- $addbutton = html_writer::tag('div', $addinput, array('id' => 'addcontrols'));
- $removeinput = html_writer::empty_tag('input',
- array('name' => 'remove', 'id' => 'remove', 'type' => 'submit',
- 'value' => $removearrow . ' ' . get_string('remove'),
- 'title' => get_string('remove')));
- $removebutton = html_writer::tag('div', $removeinput, array('id' => 'removecontrols'));
- //create the three cells
- $label = html_writer::tag('label', get_string('serviceusers', 'webservice'),
- array('for' => 'removeselect'));
- $label = html_writer::tag('p', $label);
- $authoriseduserscell = new html_table_cell($label .
- $options->alloweduserselector->display(true));
- $authoriseduserscell->id = 'existingcell';
- $buttonscell = new html_table_cell($addbutton . html_writer::empty_tag('br') . $removebutton);
- $buttonscell->id = 'buttonscell';
- $label = html_writer::tag('label', get_string('potusers', 'webservice'),
- array('for' => 'addselect'));
- $label = html_writer::tag('p', $label);
- $otheruserscell = new html_table_cell($label .
- $options->potentialuserselector->display(true));
- $otheruserscell->id = 'potentialcell';
- $cells = array($authoriseduserscell, $buttonscell, $otheruserscell);
- $row = new html_table_row($cells);
- $table->data[] = $row;
- $formcontent .= html_writer::table($table);
- $formcontent = html_writer::tag('div', $formcontent);
- $actionurl = new moodle_url('/' . $CFG->admin . '/webservice/service_users.php',
- array('id' => $options->serviceid));
- $html = html_writer::tag('form', $formcontent,
- array('id' => 'assignform', 'action' => $actionurl, 'method' => 'post'));
- return $html;
- }
- /**
- * Display list of authorised users
- *
- * @param array $users authorised users
- * @param int $serviceid service id
- * @return string $html
- */
- public function admin_authorised_user_list($users, $serviceid) {
- global $CFG;
- $html = $this->output->box_start('generalbox', 'alloweduserlist');
- foreach ($users as $user) {
- $modifiedauthoriseduserurl = new moodle_url('/' . $CFG->admin . '/webservice/service_user_settings.php',
- array('userid' => $user->id, 'serviceid' => $serviceid));
- $html .= html_writer::tag('a', $user->firstname . " "
- . $user->lastname . ", " . $user->email,
- array('href' => $modifiedauthoriseduserurl));
- //add missing capabilities
- if (!empty($user->missingcapabilities)) {
- $html .= html_writer::tag('div',
- get_string('usermissingcaps', 'webservice', $user->missingcapabilities)
- . ' ' . $this->output->help_icon('missingcaps', 'webservice'),
- array('class' => 'missingcaps', 'id' => 'usermissingcaps'));
- $html .= html_writer::empty_tag('br');
- } else {
- $html .= html_writer::empty_tag('br') . html_writer::empty_tag('br');
- }
- }
- $html .= $this->output->box_end();
- return $html;
- }
- /**
- * Display a confirmation page to remove a function from a service
- *
- * @param stdClass $function It needs function id + function name properties.
- * @param stdClass $service It needs service id + service name properties.
- * @return string html
- */
- public function admin_remove_service_function_confirmation($function, $service) {
- $optionsyes = array('id' => $service->id, 'action' => 'delete',
- 'confirm' => 1, 'sesskey' => sesskey(), 'fid' => $function->id);
- $optionsno = array('id' => $service->id);
- $formcontinue = new single_button(new moodle_url('service_functions.php',
- $optionsyes), get_string('remove'));
- $formcancel = new single_button(new moodle_url('service_functions.php',
- $optionsno), get_string('cancel'), 'get');
- return $this->output->confirm(get_string('removefunctionconfirm', 'webservice',
- (object) array('service' => $service->name, 'function' => $function->name)),
- $formcontinue, $formcancel);
- }
- /**
- * Display a confirmation page to remove a service
- *
- * @param stdClass $service It needs service id + service name properties.
- * @return string html
- */
- public function admin_remove_service_confirmation($service) {
- global $CFG;
- $optionsyes = array('id' => $service->id, 'action' => 'delete',
- 'confirm' => 1, 'sesskey' => sesskey());
- $optionsno = array('section' => 'externalservices');
- $formcontinue = new single_button(new moodle_url('service.php', $optionsyes),
- get_string('delete'), 'post');
- $formcancel = new single_button(
- new moodle_url($CFG->wwwroot . "/" . $CFG->admin . "/settings.php", $optionsno),
- get_string('cancel'), 'get');
- return $this->output->confirm(get_string('deleteserviceconfirm', 'webservice', $service->name),
- $formcontinue, $formcancel);
- }
- /**
- * Display a confirmation page to delete a token
- *
- * @param stdClass $token Required properties: id (token id), firstname (user firstname), lastname (user lastname), name (service name)
- * @return string html
- */
- public function admin_delete_token_confirmation($token) {
- global $CFG;
- $optionsyes = array('tokenid' => $token->id, 'action' => 'delete',
- 'confirm' => 1, 'sesskey' => sesskey());
- $optionsno = array('section' => 'webservicetokens', 'sesskey' => sesskey());
- $formcontinue = new single_button(
- new moodle_url('/' . $CFG->admin . '/webservice/tokens.php', $optionsyes),
- get_string('delete'));
- $formcancel = new single_button(
- new moodle_url('/' . $CFG->admin . '/settings.php', $optionsno),
- get_string('cancel'), 'get');
- return $this->output->confirm(get_string('deletetokenconfirm', 'webservice',
- (object) array('user' => $token->firstname . " "
- . $token->lastname, 'service' => $token->name)),
- $formcontinue, $formcancel);
- }
- /**
- * Display a list of functions for a given service
- * If the service is built-in, do not display remove/add operation (read-only)
- *
- * @param array $functions list of functions
- * @param stdClass $service the given service
- * @return string the table html + add operation html
- */
- public function admin_service_function_list($functions, $service) {
- global $CFG;
- if (!empty($functions)) {
- $table = new html_table();
- $table->head = array(get_string('function', 'webservice'),
- get_string('description'), get_string('requiredcaps', 'webservice'));
- $table->align = array('left', 'left', 'left');
- $table->size = array('15%', '40%', '40%');
- $table->width = '100%';
- $table->align[] = 'left';
- //display remove function operation (except for build-in service)
- if (empty($service->component)) {
- $table->head[] = get_string('edit');
- $table->align[] = 'center';
- }
- $anydeprecated = false;
- foreach ($functions as $function) {
- $function = external_api::external_function_info($function);
- if (!empty($function->deprecated)) {
- $anydeprecated = true;
- }
- $requiredcaps = html_writer::tag('div',
- empty($function->capabilities) ? '' : $function->capabilities,
- array('class' => 'functiondesc'));
- ;
- $description = html_writer::tag('div', $function->description,
- array('class' => 'functiondesc'));
- //display remove function operation (except for build-in service)
- if (empty($service->component)) {
- $removeurl = new moodle_url('/' . $CFG->admin . '/webservice/service_functions.php',
- array('sesskey' => sesskey(), 'fid' => $function->id,
- 'id' => $service->id,
- 'action' => 'delete'));
- $removelink = html_writer::tag('a',
- get_string('removefunction', 'webservice'),
- array('href' => $removeurl));
- $table->data[] = array($function->name, $description, $requiredcaps, $removelink);
- } else {
- $table->data[] = array($function->name, $description, $requiredcaps);
- }
- }
- $html = html_writer::table($table);
- } else {
- $html = get_string('nofunctions', 'webservice') . html_writer::empty_tag('br');
- }
- //display add function operation (except for build-in service)
- if (empty($service->component)) {
- if (!empty($anydeprecated)) {
- debugging('This service uses deprecated functions, replace them by the proposed ones and update your client/s.', DEBUG_DEVELOPER);
- }
- $addurl = new moodle_url('/' . $CFG->admin . '/webservice/service_functions.php',
- array('sesskey' => sesskey(), 'id' => $service->id, 'action' => 'add'));
- $html .= html_writer::tag('a', get_string('addfunctions', 'webservice'), array('href' => $addurl));
- }
- return $html;
- }
- /**
- * Display Reset token confirmation box
- *
- * @param stdClass $token token to reset
- * @return string html
- */
- public function user_reset_token_confirmation($token) {
- global $CFG;
- $managetokenurl = $CFG->wwwroot . "/user/managetoken.php?sesskey=" . sesskey();
- $optionsyes = array('tokenid' => $token->id, 'action' => 'resetwstoken', 'confirm' => 1,
- 'sesskey' => sesskey());
- $optionsno = array('section' => 'webservicetokens', 'sesskey' => sesskey());
- $formcontinue = new single_button(new moodle_url($managetokenurl, $optionsyes),
- get_string('reset'));
- $formcancel = new single_button(new moodle_url($managetokenurl, $optionsno),
- get_string('cancel'), 'get');
- $html = $this->output->confirm(get_string('resettokenconfirm', 'webservice',
- (object) array('user' => $token->firstname . " " .
- $token->lastname, 'service' => $token->name)),
- $formcontinue, $formcancel);
- return $html;
- }
- /**
- * Display user tokens with buttons to reset them
- *
- * @param stdClass $tokens user tokens
- * @param int $userid user id
- * @param bool $documentation if true display a link to the API documentation
- * @return string html code
- */
- public function user_webservice_tokens_box($tokens, $userid, $documentation = false) {
- global $CFG, $DB;
- // display strings
- $stroperation = get_string('operation', 'webservice');
- $strtoken = get_string('key', 'webservice');
- $strservice = get_string('service', 'webservice');
- $strcreator = get_string('tokencreator', 'webservice');
- $strcontext = get_string('context', 'webservice');
- $strvaliduntil = get_string('validuntil', 'webservice');
- $return = $this->output->heading(get_string('securitykeys', 'webservice'), 3, 'main', true);
- $return .= $this->output->box_start('generalbox webservicestokenui');
- $return .= get_string('keyshelp', 'webservice');
- $table = new html_table();
- $table->head = array($strtoken, $strservice, $strvaliduntil, $strcreator, $stroperation);
- $table->align = array('left', 'left', 'left', 'center', 'left', 'center');
- $table->width = '100%';
- $table->data = array();
- if ($documentation) {
- $table->head[] = get_string('doc', 'webservice');
- $table->align[] = 'center';
- }
- if (!empty($tokens)) {
- foreach ($tokens as $token) {
- if ($token->creatorid == $userid) {
- $reset = "<a href=\"" . $CFG->wwwroot . "/user/managetoken.php?sesskey="
- . sesskey() . "&action=resetwstoken&tokenid=" . $token->id . "\">";
- $reset .= get_string('reset') . "</a>";
- $creator = $token->firstname . " " . $token->lastname;
- } else {
- //retrieve administrator name
- $admincreator = $DB->get_record('user', array('id'=>$token->creatorid));
- $creator = $admincreator->firstname . " " . $admincreator->lastname;
- $reset = '';
- }
- $userprofilurl = new moodle_url('/user/view.php?id=' . $token->creatorid);
- $creatoratag = html_writer::start_tag('a', array('href' => $userprofilurl));
- $creatoratag .= $creator;
- $creatoratag .= html_writer::end_tag('a');
- $validuntil = '';
- if (!empty($token->validuntil)) {
- $validuntil = userdate($token->validuntil, get_string('strftimedatetime', 'langconfig'));
- }
- $tokenname = $token->name;
- if (!$token->enabled) { //that is the (1 token-1ws) related ws is not enabled.
- $tokenname = '<span class="dimmed_text">'.$token->name.'</span>';
- }
- $row = array($token->token, $tokenname, $validuntil, $creatoratag, $reset);
- if ($documentation) {
- $doclink = new moodle_url('/webservice/wsdoc.php',
- array('id' => $token->id, 'sesskey' => sesskey()));
- $row[] = html_writer::tag('a', get_string('doc', 'webservice'),
- array('href' => $doclink));
- }
- $table->data[] = $row;
- }
- $return .= html_writer::table($table);
- } else {
- $return .= get_string('notoken', 'webservice');
- }
- $return .= $this->output->box_end();
- return $return;
- }
- /**
- * Return documentation for a ws description object
- * ws description object can be 'external_multiple_structure', 'external_single_structure'
- * or 'external_value'
- *
- * Example of documentation for core_group_create_groups function:
- * list of (
- * object {
- * courseid int //id of course
- * name string //multilang compatible name, course unique
- * description string //group description text
- * enrolmentkey string //group enrol secret phrase
- * }
- * )
- *
- * @param stdClass $params a part of parameter/return description
- * @return string the html to display
- */
- public function detailed_description_html($params) {
- // retrieve the description of the description object
- $paramdesc = "";
- if (!empty($params->desc)) {
- $paramdesc .= html_writer::start_tag('span', array('style' => "color:#2A33A6"));
- if ($params->required == VALUE_REQUIRED) {
- $required = '';
- }
- if ($params->required == VALUE_DEFAULT) {
- if ($params->default === null) {
- $params->default = "null";
- }
- $required = html_writer::start_tag('b', array()) .
- get_string('default', 'webservice', print_r($params->default, true))
- . html_writer::end_tag('b');
- }
- if ($params->required == VALUE_OPTIONAL) {
- $required = html_writer::start_tag('b', array()) .
- get_string('optional', 'webservice') . html_writer::end_tag('b');
- }
- $paramdesc .= " " . $required . " ";
- $paramdesc .= html_writer::start_tag('i', array());
- $paramdesc .= "//";
- $paramdesc .= $params->desc;
- $paramdesc .= html_writer::end_tag('i');
- $paramdesc .= html_writer::end_tag('span');
- $paramdesc .= html_writer::empty_tag('br', array());
- }
- // description object is a list
- if ($params instanceof external_multiple_structure) {
- return $paramdesc . "list of ( " . html_writer::empty_tag('br', array())
- . $this->detailed_description_html($params->content) . ")";
- } else if ($params instanceof external_single_structure) {
- // description object is an object
- $singlestructuredesc = $paramdesc . "object {" . html_writer::empty_tag('br', array());
- foreach ($params->keys as $attributname => $attribut) {
- $singlestructuredesc .= html_writer::start_tag('b', array());
- $singlestructuredesc .= $attributname;
- $singlestructuredesc .= html_writer::end_tag('b');
- $singlestructuredesc .= " " .
- $this->detailed_description_html($params->keys[$attributname]);
- }
- $singlestructuredesc .= "} ";
- $singlestructuredesc .= html_writer::empty_tag('br', array());
- return $singlestructuredesc;
- } else {
- // description object is a primary type (string, integer)
- switch ($params->type) {
- case PARAM_BOOL: // 0 or 1 only for now
- case PARAM_INT:
- $type = 'int';
- break;
- case PARAM_FLOAT;
- $type = 'double';
- break;
- default:
- $type = 'string';
- }
- return $type . " " . $paramdesc;
- }
- }
- /**
- * Return a description object in indented xml format (for REST response)
- * It is indented to be output within <pre> tags
- *
- * @param external_description $returndescription the description structure of the web service function returned value
- * @param string $indentation Indentation in the generated HTML code; should contain only spaces.
- * @return string the html to diplay
- */
- public function description_in_indented_xml_format($returndescription, $indentation = "") {
- $indentation = $indentation . " ";
- $brakeline = <<<EOF
- EOF;
- // description object is a list
- if ($returndescription instanceof external_multiple_structure) {
- $return = $indentation . "<MULTIPLE>" . $brakeline;
- $return .= $this->description_in_indented_xml_format($returndescription->content,
- $indentation);
- $return .= $indentation . "</MULTIPLE>" . $brakeline;
- return $return;
- } else if ($returndescription instanceof external_single_structure) {
- // description object is an object
- $singlestructuredesc = $indentation . "<SINGLE>" . $brakeline;
- $keyindentation = $indentation . " ";
- foreach ($returndescription->keys as $attributname => $attribut) {
- $singlestructuredesc .= $keyindentation . "<KEY name=\"" . $attributname . "\">"
- . $brakeline .
- $this->description_in_indented_xml_format(
- $returndescription->keys[$attributname], $keyindentation) .
- $keyindentation . "</KEY>" . $brakeline;
- }
- $singlestructuredesc .= $indentation . "</SINGLE>" . $brakeline;
- return $singlestructuredesc;
- } else {
- // description object is a primary type (string, integer)
- switch ($returndescription->type) {
- case PARAM_BOOL: // 0 or 1 only for now
- case PARAM_INT:
- $type = 'int';
- break;
- case PARAM_FLOAT;
- $type = 'double';
- break;
- default:
- $type = 'string';
- }
- return $indentation . "<VALUE>" . $type . "</VALUE>" . $brakeline;
- }
- }
- /**
- * Create indented XML-RPC param description
- *
- * @param external_description $paramdescription the description structure of the web service function parameters
- * @param string $indentation Indentation in the generated HTML code; should contain only spaces.
- * @return string the html to diplay
- */
- public function xmlrpc_param_description_html($paramdescription, $indentation = "") {
- $indentation = $indentation . " ";
- $brakeline = <<<EOF
- EOF;
- // description object is a list
- if ($paramdescription instanceof external_multiple_structure) {
- $return = $brakeline . $indentation . "Array ";
- $indentation = $indentation . " ";
- $return .= $brakeline . $indentation . "(";
- $return .= $brakeline . $indentation . "[0] =>";
- $return .= $this->xmlrpc_param_description_html($paramdescription->content, $indentation);
- $return .= $brakeline . $indentation . ")";
- return $return;
- } else if ($paramdescription instanceof external_single_structure) {
- // description object is an object
- $singlestructuredesc = $brakeline . $indentation . "Array ";
- $keyindentation = $indentation . " ";
- $singlestructuredesc .= $brakeline . $keyindentation . "(";
- foreach ($paramdescription->keys as $attributname => $attribut) {
- $singlestructuredesc .= $brakeline . $keyindentation . "[" . $attributname . "] =>" .
- $this->xmlrpc_param_description_html(
- $paramdescription->keys[$attributname], $keyindentation) .
- $keyindentation;
- }
- $singlestructuredesc .= $brakeline . $keyindentation . ")";
- return $singlestructuredesc;
- } else {
- // description object is a primary type (string, integer)
- switch ($paramdescription->type) {
- case PARAM_BOOL: // 0 or 1 only for now
- case PARAM_INT:
- $type = 'int';
- break;
- case PARAM_FLOAT;
- $type = 'double';
- break;
- default:
- $type = 'string';
- }
- return " " . $type;
- }
- }
- /**
- * Return the html of a coloured box with content
- *
- * @param string $title - the title of the box
- * @param string $content - the content to displayed
- * @param string $rgb - the background color of the box
- * @return string HTML code
- */
- public function colored_box_with_pre_tag($title, $content, $rgb = 'FEEBE5') {
- //TODO MDL-31192 this tag removes xhtml strict error but cause warning
- $coloredbox = html_writer::start_tag('div', array());
- $coloredbox .= html_writer::start_tag('div',
- array('style' => "border:solid 1px #DEDEDE;background:#" . $rgb
- . ";color:#222222;padding:4px;"));
- $coloredbox .= html_writer::start_tag('pre', array());
- $coloredbox .= html_writer::start_tag('b', array());
- $coloredbox .= $title;
- $coloredbox .= html_writer::end_tag('b', array());
- $coloredbox .= html_writer::empty_tag('br', array());
- $coloredbox .= "\n" . $content . "\n";
- $coloredbox .= html_writer::end_tag('pre', array());
- $coloredbox .= html_writer::end_tag('div', array());
- $coloredbox .= html_writer::end_tag('div', array());
- return $coloredbox;
- }
- /**
- * Return indented REST param description
- *
- * @param external_description $paramdescription the description structure of the web service function parameters
- * @param string $paramstring parameter
- * @return string the html to diplay
- */
- public function rest_param_description_html($paramdescription, $paramstring) {
- $brakeline = <<<EOF
- EOF;
- // description object is a list
- if ($paramdescription instanceof external_multiple_structure) {
- $paramstring = $paramstring . '[0]';
- $return = $this->rest_param_description_html($paramdescription->content, $paramstring);
- return $return;
- } else if ($paramdescription instanceof external_single_structure) {
- // description object is an object
- $singlestructuredesc = "";
- $initialparamstring = $paramstring;
- foreach ($paramdescription->keys as $attributname => $attribut) {
- $paramstring = $initialparamstring . '[' . $attributname . ']';
- $singlestructuredesc .= $this->rest_param_description_html(
- $paramdescription->keys[$attributname], $paramstring);
- }
- return $singlestructuredesc;
- } else {
- // description object is a primary type (string, integer)
- $paramstring = $paramstring . '=';
- switch ($paramdescription->type) {
- case PARAM_BOOL: // 0 or 1 only for now
- case PARAM_INT:
- $type = 'int';
- break;
- case PARAM_FLOAT;
- $type = 'double';
- break;
- default:
- $type = 'string';
- }
- return $paramstring . " " . $type . $brakeline;
- }
- }
- /**
- * Displays all the documentation
- *
- * @param array $functions external_description of all the web service functions
- * @param boolean $printableformat true if we want to display the documentation in a printable format
- * @param array $activatedprotocol the currently enabled protocol
- * @param array $authparams url parameters (it contains 'tokenid' and sometimes 'print')
- * @param string $parenturl url of the calling page - needed for the print button url:
- * '/admin/documentation.php' or '/webservice/wsdoc.php' (default)
- * @return string the html to diplay
- */
- public function documentation_html($functions, $printableformat, $activatedprotocol,
- $authparams, $parenturl = '/webservice/wsdoc.php') {
- $documentationhtml = $this->output->heading(get_string('wsdocapi', 'webservice'));
- $br = html_writer::empty_tag('br', array());
- $brakeline = <<<EOF
- EOF;
- // Some general information
- $docinfo = new stdClass();
- $docurl = new moodle_url('http://docs.moodle.org/dev/Creating_a_web_service_client');
- $docinfo->doclink = html_writer::tag('a',
- get_string('wsclientdoc', 'webservice'), array('href' => $docurl));
- $documentationhtml .= get_string('wsdocumentationintro', 'webservice', $docinfo);
- $documentationhtml .= $br . $br;
- // Print button
- $authparams['print'] = true;
- $url = new moodle_url($parenturl, $authparams); // Required
- $documentationhtml .= $this->output->single_button($url, get_string('print', 'webservice'));
- $documentationhtml .= $br;
- // each functions will be displayed into a collapsible region
- //(opened if printableformat = true)
- foreach ($functions as $functionname => $description) {
- if (empty($printableformat)) {
- $documentationhtml .= print_collapsible_region_start('',
- 'aera_' . $functionname,
- html_writer::start_tag('strong', array())
- . $functionname . html_writer::end_tag('strong'),
- false,
- !$printableformat,
- true);
- } else {
- $documentationhtml .= html_writer::tag('strong', $functionname);
- $documentationhtml .= $br;
- }
- // function global description
- $documentationhtml .= $br;
- $documentationhtml .= html_writer::start_tag('div',
- array('style' => 'border:solid 1px #DEDEDE;background:#E2E0E0;
- color:#222222;padding:4px;'));
- $documentationhtml .= $description->description;
- $documentationhtml .= html_writer::end_tag('div');
- $documentationhtml .= $br . $br;
- // function arguments documentation
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
- $documentationhtml .= get_string('arguments', 'webservice');
- $documentationhtml .= html_writer::end_tag('span');
- $documentationhtml .= $br;
- foreach ($description->parameters_desc->keys as $paramname => $paramdesc) {
- // a argument documentation
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'font-size:80%'));
- if ($paramdesc->required == VALUE_REQUIRED) {
- $required = get_string('required', 'webservice');
- }
- if ($paramdesc->required == VALUE_DEFAULT) {
- if ($paramdesc->default === null) {
- $default = "null";
- } else {
- $default = print_r($paramdesc->default, true);
- }
- $required = get_string('default', 'webservice', $default);
- }
- if ($paramdesc->required == VALUE_OPTIONAL) {
- $required = get_string('optional', 'webservice');
- }
- $documentationhtml .= html_writer::start_tag('b', array());
- $documentationhtml .= $paramname;
- $documentationhtml .= html_writer::end_tag('b');
- $documentationhtml .= " (" . $required . ")"; // argument is required or optional ?
- $documentationhtml .= $br;
- $documentationhtml .= " "
- . $paramdesc->desc; // argument description
- $documentationhtml .= $br . $br;
- // general structure of the argument
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('generalstructure', 'webservice'),
- $this->detailed_description_html($paramdesc),
- 'FFF1BC');
- // xml-rpc structure of the argument in PHP format
- if (!empty($activatedprotocol['xmlrpc'])) {
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('phpparam', 'webservice'),
- htmlentities('[' . $paramname . '] =>'
- . $this->xmlrpc_param_description_html($paramdesc)),
- 'DFEEE7');
- }
- // POST format for the REST protocol for the argument
- if (!empty($activatedprotocol['rest'])) {
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('restparam', 'webservice'),
- htmlentities($this->rest_param_description_html(
- $paramdesc, $paramname)),
- 'FEEBE5');
- }
- $documentationhtml .= html_writer::end_tag('span');
- }
- $documentationhtml .= $br . $br;
- // function response documentation
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
- $documentationhtml .= get_string('response', 'webservice');
- $documentationhtml .= html_writer::end_tag('span');
- $documentationhtml .= $br;
- // function response description
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'font-size:80%'));
- if (!empty($description->returns_desc->desc)) {
- $documentationhtml .= $description->returns_desc->desc;
- $documentationhtml .= $br . $br;
- }
- if (!empty($description->returns_desc)) {
- // general structure of the response
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('generalstructure', 'webservice'),
- $this->detailed_description_html($description->returns_desc),
- 'FFF1BC');
- // xml-rpc structure of the response in PHP format
- if (!empty($activatedprotocol['xmlrpc'])) {
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('phpresponse', 'webservice'),
- htmlentities($this->xmlrpc_param_description_html(
- $description->returns_desc)),
- 'DFEEE7');
- }
- // XML response for the REST protocol
- if (!empty($activatedprotocol['rest'])) {
- $restresponse = "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>"
- . $brakeline . "<RESPONSE>" . $brakeline;
- $restresponse .= $this->description_in_indented_xml_format(
- $description->returns_desc);
- $restresponse .="</RESPONSE>" . $brakeline;
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('restcode', 'webservice'),
- htmlentities($restresponse),
- 'FEEBE5');
- }
- }
- $documentationhtml .= html_writer::end_tag('span');
- $documentationhtml .= $br . $br;
- // function errors documentation for REST protocol
- if (!empty($activatedprotocol['rest'])) {
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
- $documentationhtml .= get_string('errorcodes', 'webservice');
- $documentationhtml .= html_writer::end_tag('span');
- $documentationhtml .= $br . $br;
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'font-size:80%'));
- $errormessage = get_string('invalidparameter', 'debug');
- $restexceptiontext = <<<EOF
- <?xml version="1.0" encoding="UTF-8"?>
- <EXCEPTION class="invalid_parameter_exception">
- <MESSAGE>{$errormessage}</MESSAGE>
- <DEBUGINFO></DEBUGINFO>
- </EXCEPTION>
- EOF;
- $documentationhtml .= $this->colored_box_with_pre_tag(
- get_string('restexception', 'webservice'),
- htmlentities($restexceptiontext),
- 'FEEBE5');
- $documentationhtml .= html_writer::end_tag('span');
- }
- $documentationhtml .= $br . $br;
- // Login required info.
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
- $documentationhtml .= get_string('loginrequired', 'webservice') . $br;
- $documentationhtml .= html_writer::end_tag('span');
- $documentationhtml .= $description->loginrequired ? get_string('yes') : get_string('no');
- $documentationhtml .= $br . $br;
- // Ajax info.
- $documentationhtml .= html_writer::start_tag('span', array('style' => 'color:#EA33A6'));
- $documentationhtml .= get_string('callablefromajax', 'webservice') . $br;
- $documentationhtml .= html_writer::end_tag('span');
- $documentationhtml .= $description->allowed_from_ajax ? get_string('yes') : get_string('no');
- $documentationhtml .= $br . $br;
- if (empty($printableformat)) {
- $documentationhtml .= print_collapsible_region_end(true);
- }
- }
- return $documentationhtml;
- }
- }
|