Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250706) (a6b17d8f6bd)
auth_lti\output\renderer Class Reference
Inheritance diagram for auth_lti\output\renderer:

Public Member Functions

 render_account_binding_complete (notification $notification, moodle_url $returnurl)
 Render the page displayed when the account binding is complete, letting the user continue to the launch.
 
 render_account_binding_options_page (int $provisioningmode)
 Render the account options view, displayed to instructors on first launch if no account binding exists.
 

Member Function Documentation

◆ render_account_binding_complete()

auth_lti\output\renderer::render_account_binding_complete ( notification $notification,
moodle_url $returnurl )

Render the page displayed when the account binding is complete, letting the user continue to the launch.

Callers can provide different messages depending on which type of binding took place. For example, a newly provisioned account may require a slightly different message to an existing account being linked.

The return URL is the page the user will be taken back to when they click 'Continue'. This is likely the launch or deeplink launch endpoint but could be any calling code in LTI which wants to use the account binding workflow.

Parameters
notification$notificationthe notification containing the message describing the binding success.
moodle_url$returnurlthe URL to return to when the user clicks continue on the rendered page.
Return values
stringthe rendered HTML

◆ render_account_binding_options_page()

auth_lti\output\renderer::render_account_binding_options_page ( int $provisioningmode)

Render the account options view, displayed to instructors on first launch if no account binding exists.

Parameters
int$provisioningmodethe desired account provisioning mode, see auth_plugin_lti constants for details.
Return values
stringthe html.

The documentation for this class was generated from the following file: