Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/report/outline/ -> lib.php (source)

[Source view]

Differences Between: [Versions 400 and 402] [Versions 400 and 403]

This file contains public API of outline report

Copyright: 2009 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 153 lines (6 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 6 functions

  report_outline_extend_navigation_course()
  report_outline_extend_navigation_user()
  report_outline_can_access_user_report()
  report_outline_page_type_list()
  report_outline_supports_logstore()
  report_outline_myprofile_navigation()

Functions
Functions that are not part of a class:

report_outline_extend_navigation_course($navigation, $course, $context)   X-Ref
This function extends the course navigation with the report items

param: navigation_node $navigation The navigation node to extend
param: stdClass $course The course to object for the report
param: stdClass $context The context of the course

report_outline_extend_navigation_user($navigation, $user, $course)   X-Ref
This function extends the course navigation with the report items

param: navigation_node $navigation The navigation node to extend
param: stdClass $user
param: stdClass $course The course to object for the report

report_outline_can_access_user_report($user, $course)   X-Ref
Is current user allowed to access this report

return: bool
param: stdClass $user
param: stdClass $course

report_outline_page_type_list($pagetype, $parentcontext, $currentcontext)   X-Ref
Return a list of page types

return: array
param: string $pagetype current page type
param: stdClass $parentcontext Block's parent context
param: stdClass $currentcontext Current context of block

report_outline_supports_logstore($instance)   X-Ref
Callback to verify if the given instance of store is supported by this report or not.

return: bool returns true if the store is supported by the report, false otherwise.
param: string $instance store instance.

report_outline_myprofile_navigation(core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course)   X-Ref
Add nodes to myprofile page.

return: bool
param: \core_user\output\myprofile\tree $tree Tree object
param: stdClass $user user object
param: bool $iscurrentuser
param: stdClass $course Course object