Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

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

Course module instance list viewed event.

Copyright: 2013 onwards Ankit Agarwal
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 115 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

course_module_instance_list_viewed:: (6 methods):
  init()
  get_description()
  get_name()
  get_url()
  get_legacy_logdata()
  validate_data()


Class: course_module_instance_list_viewed  - X-Ref

Course module instance list viewed event class.

This is an abstract to guide the developers in using this event name for their events.
It is intended to be used when the user viewes the list of all the instances of a module
in a course. This replaces the historical 'view all' log entry generated in mod/somemod/index.php.

Example:

\mod_chat\event\course_module_instance_list_viewed extends \core\event\course_module_instance_list_viewed

init()   X-Ref
Init method.

return: void

get_description()   X-Ref
Returns description of what happened.

return: string

get_name()   X-Ref
Return localised event name.

return: string

get_url()   X-Ref
Get URL related to the action.

return: \moodle_url

get_legacy_logdata()   X-Ref
Return the legacy event log data.

return: array|null

validate_data()   X-Ref
Custom validation.

return: void