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_module_created.php (source)

[Source view]

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

Event to be triggered when a new course module is created.

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

Defines 1 class

course_module_created:: (11 methods):
  init()
  create_from_cm()
  get_name()
  get_description()
  get_url()
  get_legacy_eventname()
  get_legacy_eventdata()
  get_legacy_logdata()
  validate_data()
  get_objectid_mapping()
  get_other_mapping()


Class: course_module_created  - X-Ref

Class course_module_created

Class for event to be triggered when a new course module is created.

init()   X-Ref
Set basic properties for the event.


create_from_cm($cm, $modcontext = null)   X-Ref
Api to Create new event from course module.

param: \cm_info|\stdClass $cm course module instance, as returned by {@link get_coursemodule_from_id}
param: \context_module $modcontext module context instance
return: \core\event\base returns instance of new event

get_name()   X-Ref
Returns localised general 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
Legacy event name.

return: string legacy event name

get_legacy_eventdata()   X-Ref
Legacy event data.

return: \stdClass

get_legacy_logdata()   X-Ref
replace add_to_log() statement.

return: array of parameters to be passed to legacy add_to_log() function.

validate_data()   X-Ref
Custom validation.


get_objectid_mapping()   X-Ref
No description

get_other_mapping()   X-Ref
No description