help.php 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. // This file is part of Moodle - http://moodle.org/
  3. //
  4. // Moodle is free software: you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation, either version 3 of the License, or
  7. // (at your option) any later version.
  8. //
  9. // Moodle is distributed in the hope that it will be useful,
  10. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. // GNU General Public License for more details.
  13. //
  14. // You should have received a copy of the GNU General Public License
  15. // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
  16. /**
  17. * Displays help via AJAX call or in a new page
  18. *
  19. * Use {@link core_renderer::help_icon()} or {@link addHelpButton()} to display
  20. * the help icon.
  21. *
  22. * @copyright 2002 onwards Martin Dougiamas
  23. * @package core
  24. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25. */
  26. define('NO_MOODLE_COOKIES', true);
  27. require_once(__DIR__ . '/config.php');
  28. $identifier = required_param('identifier', PARAM_STRINGID);
  29. $component = required_param('component', PARAM_COMPONENT);
  30. $lang = optional_param('lang', 'en', PARAM_LANG);
  31. // We don't actually modify the session here as we have NO_MOODLE_COOKIES set.
  32. $SESSION->lang = $lang;
  33. $PAGE->set_url('/help.php');
  34. $PAGE->set_pagelayout('popup');
  35. $PAGE->set_context(context_system::instance());
  36. $data = get_formatted_help_string($identifier, $component, false);
  37. if (!empty($data->heading)) {
  38. $PAGE->set_title($data->heading);
  39. } else {
  40. $PAGE->set_title(get_string('help'));
  41. }
  42. echo $OUTPUT->header();
  43. if (!empty($data->heading)) {
  44. echo $OUTPUT->heading($data->heading, 1, 'helpheading');
  45. }
  46. echo $data->text;
  47. if (isset($data->completedoclink)) {
  48. echo $data->completedoclink;
  49. }
  50. echo $OUTPUT->footer();