Moodle release 2.5beta

[moodle.git] / help.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/>.

/**
 * Displays help via AJAX call or in a new page
 *
 * Use {@link core_renderer::help_icon()} or {@link addHelpButton()} to display
 * the help icon.
 *
 * @copyright 2002 onwards Martin Dougiamas
 * @package   core
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

define('NO_MOODLE_COOKIES', true);

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);

if (!$lang) {
    $lang = 'en';
}
$SESSION->lang = $lang; // does not actually modify session because we do not use cookies here

$sm = get_string_manager();

$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');
}

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();
}