|
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Files | |
| file | install.php |
| Post installation and migration code. | |
| file | install.php |
| Post installation and migration code. | |
| file | install.php |
| Post installation and migration code. | |
| file | install.php |
| Post installation and migration code. | |
| file | install.php |
| Post installation and migration code. | |
| file | lib.php |
| Version details. | |
| file | lib.php |
| This file contains public API of outline report. | |
| file | lib.php |
| This file contains functions used by the participation report. | |
| file | lib.php |
| This file contains functions used by the progress report. | |
| file | lib.php |
| This file contains functions used by the log reports. | |
| file | locallib.php |
| This file contains functions used by the outline reports. | |
| file | locallib.php |
| Reports implementation. | |
| file | settings.php |
| Settings for the backups report. | |
| file | settings.php |
| Report settings. | |
| file | settings.php |
| Report settings. | |
| file | settings.php |
| Settings and links. | |
| file | settings.php |
| Version info. | |
| file | version.php |
| Version details. | |
| file | version.php |
| Version details. | |
| file | version.php |
| Version details. | |
| file | version.php |
| Version info. | |
| file | version.php |
| Version info. | |
| file | version.php |
| Version info. | |
| file | version.php |
| Version details. | |
| file | version.php |
| Version info. | |
| file | version.php |
| Version info. | |
Functions | |
| report_completion_extend_navigation_course ($navigation, $course, $context) | |
| This function extends the navigation with the report items. More... | |
| report_completion_extend_navigation_user ($navigation, $user, $course) | |
| This function extends the course navigation with the report items. More... | |
| report_completion_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. More... | |
| report_outline_extend_navigation_course ($navigation, $course, $context) | |
| This function extends the course navigation with the report items. More... | |
| report_outline_extend_navigation_user ($navigation, $user, $course) | |
| This function extends the course navigation with the report items. More... | |
| report_outline_get_common_log_variables () | |
| Returns an array of the commonly used log variables by the outline report. More... | |
| report_outline_myprofile_navigation (core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) | |
| Add nodes to myprofile page. More... | |
| report_outline_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. More... | |
| report_outline_print_row ($mod, $instance, $result) | |
| report_outline_supports_logstore ($instance) | |
| Callback to verify if the given instance of store is supported by this report or not. More... | |
| report_outline_user_complete ($userid, $cmid, $module, $instanceid) | |
| Display the most commonly used user complete information. More... | |
| report_outline_user_outline ($userid, $cmid, $module, $instanceid) | |
| Return the most commonly used user outline information. More... | |
| report_participation_extend_navigation_course ($navigation, $course, $context) | |
| This function extends the navigation with the report items. More... | |
| report_participation_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. More... | |
| report_participation_supports_logstore ($instance) | |
| Callback to verify if the given instance of store is supported by this report or not. More... | |
| report_progress_extend_navigation_course ($navigation, $course, $context) | |
| This function extends the navigation with the report items. More... | |
| report_progress_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. More... | |
| report_stats_extend_navigation_course ($navigation, $course, $context) | |
| This function extends the navigation with the report items. More... | |
| report_stats_extend_navigation_user ($navigation, $user, $course) | |
| This function extends the course navigation with the report items. More... | |
| report_stats_mode_menu ($course, $mode, $time, $url) | |
| report_stats_myprofile_navigation (core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) | |
| Add nodes to myprofile page. More... | |
| report_stats_page_type_list ($pagetype, $parentcontext, $currentcontext) | |
| Return a list of page types. More... | |
| report_stats_print_chart ($courseid, $report, $time, $mode, $userid=0, $roleid=0) | |
| Fetch statistics data and generate a line chart. More... | |
| report_stats_report ($course, $report, $mode, $user, $roleid, $time) | |
| report_stats_supports_logstore ($instance) | |
| Callback to verify if the given instance of store is supported by this report or not. More... | |
| report_stats_timeoptions ($mode) | |
| xmldb_report_completion_install () | |
| xmldb_report_outline_install () | |
| xmldb_report_participation_install () | |
| xmldb_report_progress_install () | |
| xmldb_report_stats_install () | |
| report_completion_extend_navigation_course | ( | $navigation, | |
| $course, | |||
| $context | |||
| ) |
This function extends the navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $course | The course to object for the report |
| stdClass | $context | The context of the course |
| report_completion_extend_navigation_user | ( | $navigation, | |
| $user, | |||
| $course | |||
| ) |
This function extends the course navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $user | |
| stdClass | $course | The course to object for the report |
| report_completion_page_type_list | ( | $pagetype, | |
| $parentcontext, | |||
| $currentcontext | |||
| ) |
Return a list of page types.
| string | $pagetype | current page type |
| stdClass | $parentcontext | Block's parent context |
| stdClass | $currentcontext | Current context of block |
| array |
| report_outline_extend_navigation_course | ( | $navigation, | |
| $course, | |||
| $context | |||
| ) |
This function extends the course navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $course | The course to object for the report |
| stdClass | $context | The context of the course |
| report_outline_extend_navigation_user | ( | $navigation, | |
| $user, | |||
| $course | |||
| ) |
This function extends the course navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $user | |
| stdClass | $course | The course to object for the report |
| report_outline_get_common_log_variables | ( | ) |
Returns an array of the commonly used log variables by the outline report.
| array | the array of variables used |
| report_outline_myprofile_navigation | ( | core_user\output\myprofile\tree | $tree, |
| $user, | |||
| $iscurrentuser, | |||
| $course | |||
| ) |
Add nodes to myprofile page.
| core_user::output::myprofile::tree | $tree | Tree object |
| stdClass | $user | user object |
| bool | $iscurrentuser | |
| stdClass | $course | Course object |
| bool |
| report_outline_page_type_list | ( | $pagetype, | |
| $parentcontext, | |||
| $currentcontext | |||
| ) |
Return a list of page types.
| string | $pagetype | current page type |
| stdClass | $parentcontext | Block's parent context |
| stdClass | $currentcontext | Current context of block |
| array |
| report_outline_supports_logstore | ( | $instance | ) |
Callback to verify if the given instance of store is supported by this report or not.
| string | $instance | store instance. |
| bool | returns true if the store is supported by the report, false otherwise. |
| report_outline_user_complete | ( | $userid, | |
| $cmid, | |||
| $module, | |||
| $instanceid | |||
| ) |
Display the most commonly used user complete information.
| int | $userid | the id of the user |
| int | $cmid | the course module id |
| string | $module | the name of the module (eg. 'book') |
| int | $instanceid | (eg. the 'id' in the 'book' table) |
| string |
| report_outline_user_outline | ( | $userid, | |
| $cmid, | |||
| $module, | |||
| $instanceid | |||
| ) |
Return the most commonly used user outline information.
| int | $userid | the id of the user |
| int | $cmid | the course module id |
| string | $module | the name of the module (eg. 'book') |
| int | $instanceid | (eg. the 'id' in the 'book' table) |
| stdClass|null | if any information is found then a stdClass containing this info is returned, else null is. |
| report_participation_extend_navigation_course | ( | $navigation, | |
| $course, | |||
| $context | |||
| ) |
This function extends the navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $course | The course to object for the report |
| stdClass | $context | The context of the course |
| report_participation_page_type_list | ( | $pagetype, | |
| $parentcontext, | |||
| $currentcontext | |||
| ) |
Return a list of page types.
| string | $pagetype | current page type |
| stdClass | $parentcontext | Block's parent context |
| stdClass | $currentcontext | Current context of block |
| array |
| report_participation_supports_logstore | ( | $instance | ) |
Callback to verify if the given instance of store is supported by this report or not.
| string | $instance | store instance. |
| bool | returns true if the store is supported by the report, false otherwise. |
| report_progress_extend_navigation_course | ( | $navigation, | |
| $course, | |||
| $context | |||
| ) |
This function extends the navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $course | The course to object for the report |
| stdClass | $context | The context of the course |
| report_progress_page_type_list | ( | $pagetype, | |
| $parentcontext, | |||
| $currentcontext | |||
| ) |
Return a list of page types.
| string | $pagetype | current page type |
| stdClass | $parentcontext | Block's parent context |
| stdClass | $currentcontext | Current context of block |
| array |
| report_stats_extend_navigation_course | ( | $navigation, | |
| $course, | |||
| $context | |||
| ) |
This function extends the navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $course | The course to object for the report |
| stdClass | $context | The context of the course |
| report_stats_extend_navigation_user | ( | $navigation, | |
| $user, | |||
| $course | |||
| ) |
This function extends the course navigation with the report items.
| navigation_node | $navigation | The navigation node to extend |
| stdClass | $user | |
| stdClass | $course | The course to object for the report |
| report_stats_myprofile_navigation | ( | core_user\output\myprofile\tree | $tree, |
| $user, | |||
| $iscurrentuser, | |||
| $course | |||
| ) |
Add nodes to myprofile page.
| core_user::output::myprofile::tree | $tree | Tree object |
| stdClass | $user | user object |
| bool | $iscurrentuser | |
| stdClass | $course | Course object |
| bool |
| report_stats_page_type_list | ( | $pagetype, | |
| $parentcontext, | |||
| $currentcontext | |||
| ) |
Return a list of page types.
| string | $pagetype | current page type |
| stdClass | $parentcontext | Block's parent context |
| stdClass | $currentcontext | Current context of block |
| array |
| report_stats_print_chart | ( | $courseid, | |
| $report, | |||
| $time, | |||
| $mode, | |||
$userid = 0, |
|||
$roleid = 0 |
|||
| ) |
Fetch statistics data and generate a line chart.
The statistic chart can be view, posts separated by roles and dates.
| int | $courseid | course id. |
| int | $report | the report type constant eg. STATS_REPORT_LOGINS as defined on statslib. |
| int | $time | timestamp of the selected time period. |
| int | $mode | the report mode, eg. STATS_MODE_DETAILED as defined on statslib. |
| int | $userid | selected user id. |
| int | $roleid | selected role id. |
| report_stats_supports_logstore | ( | $instance | ) |
Callback to verify if the given instance of store is supported by this report or not.
| string | $instance | store instance. |
| bool | returns true if the store is supported by the report, false otherwise. |