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.
/lib/classes/event/ -> course_completed.php (source)

[Source view]

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

Course completed event.

Copyright: 2013 Rajesh Taneja <rajesh@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 148 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

course_completed:: (10 methods):
  create_from_completion()
  init()
  get_name()
  get_description()
  get_url()
  get_legacy_eventname()
  get_legacy_eventdata()
  validate_data()
  get_objectid_mapping()
  get_other_mapping()


Class: course_completed  - X-Ref

Course completed event class.

create_from_completion(\stdClass $completion)   X-Ref
Create event from course_completion record.

param: \stdClass $completion
return: course_completed

init()   X-Ref
Initialise required event data properties.


get_name()   X-Ref
Returns localised event name.

return: string

get_description()   X-Ref
Returns non-localised event description with id's for admin use only.

return: string

get_url()   X-Ref
Returns relevant URL.

return: \moodle_url

get_legacy_eventname()   X-Ref
Return name of the legacy event, which is replaced by this event.

return: string legacy event name

get_legacy_eventdata()   X-Ref
Return course_completed legacy event data.

return: \stdClass completion data.

validate_data()   X-Ref
Custom validation.

return: void

get_objectid_mapping()   X-Ref
No description

get_other_mapping()   X-Ref
No description