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.
/enrol/lti/classes/ -> tool_provider.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

Extends the IMS Tool provider library for the LTI enrolment.

Copyright: 2016 John Okely <john@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 455 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

tool_provider:: (6 methods):
  strip_base_url()
  __construct()
  onError()
  onLaunch()
  onRegister()
  map_tool_to_consumer()


Class: tool_provider  - X-Ref

Extends the IMS Tool provider library for the LTI enrolment.

strip_base_url($url)   X-Ref
Remove $this->baseUrl (wwwroot) from a given url string and return it.

param: string $url The url from which to remove the base url
return: string|null A string of the relative path to the url, or null if it couldn't be determined.

__construct($toolid)   X-Ref
Create a new instance of tool_provider to handle all the LTI tool provider interactions.

param: int $toolid The id of the tool to be provided.

onError()   X-Ref
Override onError for custom error handling.

return: void

onLaunch()   X-Ref
Override onLaunch with tool logic.

return: void

onRegister()   X-Ref
Override onRegister with registration code.


map_tool_to_consumer()   X-Ref
Performs mapping of the tool consumer to a published tool.