Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/admin/tool/monitor/ -> lib.php (source)

[Source view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403]

This page lists public api for tool_monitor plugin.

Copyright: 2014 onwards Ankit Agarwal <ankit.agrr@gmail.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 154 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  tool_monitor_extend_navigation_course()
  tool_monitor_extend_navigation_frontpage()
  tool_monitor_extend_navigation_user_settings()
  tool_monitor_can_subscribe()
  tool_monitor_get_user_courses()

Functions
Functions that are not part of a class:

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

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

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

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

tool_monitor_extend_navigation_user_settings($navigation, $user, $usercontext, $course, $coursecontext)   X-Ref
This function extends the navigation with the tool items for user settings node.

param: navigation_node $navigation  The navigation node to extend
param: stdClass        $user        The user object
param: context         $usercontext The context of the user
param: stdClass        $course      The course to object for the tool
param: context         $coursecontext     The context of the course

tool_monitor_can_subscribe()   X-Ref
Check if the user has the capacity to subscribe to an event monitor anywhere.

return: bool True if a capability in a course is found. False otherwise.

tool_monitor_get_user_courses()   X-Ref
Get a list of courses and also include 'Site' for site wide rules.

return: array|bool Returns an array of courses or false if the user has no permission to subscribe to rules.