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.
/admin/tool/usertours/classes/ -> configuration.php (source)

[Source view]

Step configuration detail class.

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

Defines 1 class

configuration:: (4 methods):
  get_defaultable_keys()
  get_default_value()
  get_step_default_value()
  get_placement_options()


Class: configuration  - X-Ref

Step configuration detail class.

get_defaultable_keys()   X-Ref
Get the list of keys which can be defaulted in the tour.

return: array

get_default_value($key)   X-Ref
Get the default value for the specified key.

param: string          $key        The key for the specified value
return: mixed

get_step_default_value($key)   X-Ref
Get the default value for the specified key for the step form.

param: string          $key        The key for the specified value
return: mixed

get_placement_options($default = null)   X-Ref
Get the list of possible placement options.

param: string          $default    The default option.
return: array