dirroot;
} else {
$helpdir = $CFG->dataroot;
}
$helpdir .= "/lang/$lang/help";
// Then which file in there we should be serving.
if ($module == 'moodle') {
$filepath = "$helpdir/$file";
} else {
$filepath = "$helpdir/$module/$file";
// If that does not exist, try a fallback into the module code folder.
if (!file_exists($filepath)) {
$filepath = "$CFG->dirroot/mod/$module/lang/$lang/help/$module/$file";
}
}
// Now, try to include the help text from this file, if we can.
if (file_exists_and_readable($filepath)) {
$helpfound = true;
@include($filepath); // The actual helpfile
// Now, we process some special cases.
if ($module == 'moodle' and ($file == 'index.html' or $file == 'mods.html')) {
include_help_for_each_module($file, $langs, $helpdir);
}
// The remaining horrible hardcoded special cases should be delegated to modules somehow.
if ($module == 'moodle' and ($file == 'resource/types.html')) { // RESOURCES
include_help_for_each_resource($file, $langs, $helpdir);
}
if ($module == 'moodle' and ($file == 'assignment/types.html')) { // ASSIGNMENTS
include_help_for_each_assignment_type();
}
// Having found some help, we break out of the loop over languages.
break;
}
}
} else {
// The help to display was given as an argument to this function.
echo ''.s($text).'
'; // This param was already cleaned
$helpfound = true;
}
print_simple_box_end();
// Display an error if necessary.
if (!$helpfound) {
notify('Help file "'. $file .'" could not be found!');
}
// End of page.
close_window_button();
echo ''. get_string('helpindex') .'
';
$CFG->docroot = ''; // We don't want a doc link here
print_footer('none');
// Utility function =================================================================
function file_exists_and_readable($filepath) {
return file_exists($filepath) and is_file($filepath) and is_readable($filepath);
}
// Some functions for handling special cases ========================================
function include_help_for_each_module($file, $langs, $helpdir) {
global $CFG;
if (!$modules = get_records('modules', 'visible', 1)) {
error('No modules found!!'); // Should never happen
}
foreach ($modules as $mod) {
$strmodulename = get_string('modulename', $mod->name);
$modulebyname[$strmodulename] = $mod;
}
ksort($modulebyname);
foreach ($modulebyname as $mod) {
foreach ($langs as $lang) {
if (empty($lang)) {
continue;
}
$filepath = "$helpdir/$mod->name/$file";
// If that does not exist, try a fallback into the module code folder.
if (!file_exists($filepath)) {
$filepath = "$CFG->dirroot/mod/$mod->name/lang/$lang/help/$mod->name/$file";
}
if (file_exists_and_readable($filepath)) {
echo '
';
@include($filepath); // The actual helpfile
break; // Out of loop over languages.
}
}
}
}
function include_help_for_each_resource($file, $langs, $helpdir) {
global $CFG;
require_once($CFG->dirroot .'/mod/resource/lib.php');
$typelist = resource_get_resource_types();
$typelist['label'] = get_string('resourcetypelabel', 'resource');
foreach ($typelist as $type => $name) {
foreach ($langs as $lang) {
if (empty($lang)) {
continue;
}
$filepath = "$helpdir/resource/type/$type.html";
if (file_exists_and_readable($filepath)) {
echo '
';
@include($filepath); // The actual helpfile
break; // Out of loop over languages.
}
}
}
}
function include_help_for_each_assignment_type() {
global $CFG;
require_once($CFG->dirroot .'/mod/assignment/lib.php');
$typelist = assignment_types();
foreach ($typelist as $type => $name) {
echo ''.$name.'
';
echo get_string('help'.$type, 'assignment');
echo '
';
}
}
?>