Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/enrol/lti/classes/output/ -> renderer.php (source)

[Source view]

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

Renderer class for LTI enrolment

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

Defines 1 class

renderer:: (4 methods):
  render_registration()
  render_published_resource_selection_view()
  render_admin_setting_registered_platforms()
  render_registration_view()


Class: renderer  - X-Ref

Renderer class for LTI enrolment

render_registration(registration $registration)   X-Ref
Render the enrol_lti/proxy_registration template

return: string html for the page
param: registration $registration The registration renderable

render_published_resource_selection_view(LtiMessageLaunch $launch, array $resources)   X-Ref
Render the content item selection (deep linking 2.0) view

This view is a form containing a list of courses and modules which, once selected and submitted, will result in
a list of LTI Resource Link Content Items being sent back to the platform, allowing resource link creation to
take place.

return: string html
param: LtiMessageLaunch $launch the launch data.
param: array $resources array of published resources available to the current user.

render_admin_setting_registered_platforms(array $registrations)   X-Ref
Render the table applications which have been registered as LTI Advantage platforms.

return: string the html.
param: array $registrations The list of registrations to render.

render_registration_view(int $registrationid, string $activetab = '')   X-Ref
Renders the registration view page, allowing admins to view tool details, platform details and deployments.

The template uses dynamic tabs, which renders with one active tab and uses js to change tabs if desired. E.g. if an anchor
link is used to go to another tab, the page will first load the active tab, then switch to the tab referenced in the anchor
using JS. To allow navigation to the page with a specific tab selected, and WITHOUT the js slowdown, this renderer method
allows callers to specify which tab is set as the active tab during first render.
Valid values correspond to the tab names in the enrol_lti/local/ltiadvantage/registration_view template, currently:
- 'tooldetails' - to render with the Tool details tab as the active tab
- 'platformdetails' - to render with the Platform details tab as the active tab
- 'tooldeployments' - to render with the Tool deployments tab as the active tab
By default, the platformdetails tab will be selected as active.

return: bool|string
param: int $registrationid the id of the registration to display information for.
param: string $activetab a string identifying the tab to preselect when rendering.