L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL 38508 JavaScript: Split out AJAX and non-AJAX help

Browse Source 
We need to keep these two separate as scripts which define AJAX_SCRIPT
before loading config.php will use a different default renderer and will
return appropriate exceptions which can be parsed by M.core.exception and
M.core.ajaxException correctly.

This also addresses an issue whereby a missing heading could break the
tooltip.
This commit is contained in:
Andrew Robert Nicols
2013-04-08 21:01:20 +01:00
committed by Andrew Nicols
parent 422f68fb86
commit 56d465b2d3
8 changed files with 307 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files
help.php
+11 -62
View File
@@ -32,73 +32,22 @@ require_once(dirname(__FILE__) . '/config.php');
$identifier = required_param('identifier', PARAM_STRINGID);
$component = required_param('component', PARAM_COMPONENT);
$lang = required_param('lang', PARAM_LANG); // TODO: maybe split into separate scripts
$ajax = optional_param('ajax', 0, PARAM_BOOL);
$lang = optional_param('lang', 'en', PARAM_LANG);
if (!$lang) {
$lang = 'en';
}
$SESSION->lang = $lang; // does not actually modify session because we do not use cookies here
$sm = get_string_manager();
// We don't actually modify the session here as we have NO_MOODLE_COOKIES set.
$SESSION->lang = $lang;
$PAGE->set_url('/help.php');
$PAGE->set_pagelayout('popup');
$PAGE->set_context(context_system::instance());
if ($ajax) {
@header('Content-Type: text/plain; charset=utf-8');
$data = get_formatted_help_string($identifier, $component, false);
echo $OUTPUT->header();
if (!empty($data->heading)) {
echo $OUTPUT->heading($data->heading, 1, 'helpheading');
}
if (!$sm->string_exists($identifier.'_help', $component)) {
// strings on disk-cache may be dirty - try to rebuild it and check again
$sm->load_component_strings($component, current_language(), true);
}
$data = new stdClass();
if ($sm->string_exists($identifier.'_help', $component)) {
$options = new stdClass();
$options->trusted = false;
$options->noclean = false;
$options->smiley = false;
$options->filter = false;
$options->para = true;
$options->newlines = false;
$options->overflowdiv = !$ajax;
$data->heading = format_string(get_string($identifier, $component));
// Should be simple wiki only MDL-21695
$data->text = format_text(get_string($identifier.'_help', $component), FORMAT_MARKDOWN, $options);
$helplink = $identifier . '_link';
if ($sm->string_exists($helplink, $component)) { // Link to further info in Moodle docs
$link = get_string($helplink, $component);
$linktext = get_string('morehelp');
$data->doclink = new stdClass();
$url = new moodle_url(get_docs_url($link));
$data->doclink->link = $url->out();
$data->doclink->linktext = $linktext;
$data->doclink->class = ($CFG->doctonewwindow) ? 'helplinkpopup' : '';
$completedoclink = html_writer::tag('div', $OUTPUT->doc_link($link, $linktext), array('class' => 'helpdoclink'));
}
} else {
$data->text = html_writer::tag('p',
html_writer::tag('strong', 'TODO') . ": missing help string [{$identifier}_help, {$component}]");
}
if ($ajax) {
echo json_encode($data);
} else {
echo $OUTPUT->header();
if (isset($data->heading)) {
echo $OUTPUT->heading($data->heading, 1, 'helpheading');
}
echo $data->text;
if (isset($completedoclink)) {
echo $completedoclink;
}
echo $OUTPUT->footer();
echo $data->text;
if (isset($data->completedoclink)) {
echo $data->completedoclink;
}
echo $OUTPUT->footer();