Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

The tool_usertours step_shown event.

Copyright: 2016 Andrew Nicols <andrew@nicols.co.uk>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 146 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

step_shown:: (7 methods):
  init()
  get_name()
  validate_data()
  get_other_mapping()
  get_objectid_mapping()
  get_description()
  get_url()


Class: step_shown  - X-Ref

The tool_usertours step_shown event.

init()   X-Ref
Init method.


get_name()   X-Ref
Returns localised general event name.

return: string

validate_data()   X-Ref
Custom validation.

return: void

get_other_mapping()   X-Ref
This is used when restoring course logs where it is required that we
map the information in 'other' to it's new value in the new course.

Does nothing in the base class except display a debugging message warning
the user that the event does not contain the required functionality to
map this information. For events that do not store any other information this
won't be called, so no debugging message will be displayed.

return: array an array of other values and their corresponding mapping

get_objectid_mapping()   X-Ref
This is used when restoring course logs where it is required that we
map the objectid to it's new value in the new course.

Does nothing in the base class except display a debugging message warning
the user that the event does not contain the required functionality to
map this information. For events that do not store an objectid this won't
be called, so no debugging message will be displayed.

return: string the name of the restore mapping the objectid links to

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