Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
enrol_lti\output\renderer Class Reference

Renderer class for LTI enrolment. More...

Inheritance diagram for enrol_lti\output\renderer:
plugin_renderer_base renderer_base

Public Member Functions

 __call ($method, $arguments)
 Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id.
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any.
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any.
 
 get_page ()
 Returns the moodle page object.
 
 has_started ()
 Returns true is output has already started, and false if not.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder.
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it.
 
 render_admin_setting_registered_platforms (array $registrations)
 Render the table applications which have been registered as LTI Advantage platforms.
 
 render_cookies_required_notice ()
 Render a warning, indicating to the user that cookies are require but couldn't be set.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_published_resource_selection_view (LtiMessageLaunch $launch, array $resources)
 Render the content item selection (deep linking 2.0) view.
 
 render_registration (registration $registration)
 Render the enrol_lti/proxy_registration template.
 
 render_registration_view (int $registrationid, string $activetab='')
 Renders the registration view page, allowing admins to view tool details, platform details and deployments.
 
 should_display_main_logo ()
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 

Static Public Member Functions

static prepare_classes ($classes)
 Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
 

Protected Member Functions

 get_mustache ()
 Return an instance of the mustache class.
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
renderer_base core_renderer $output
 A reference to the current renderer.
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 
array $templatecache = []
 $templatecache The mustache template cache.
 

Detailed Description

Renderer class for LTI enrolment.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ render_admin_setting_registered_platforms()

enrol_lti\output\renderer::render_admin_setting_registered_platforms ( array $registrations)

Render the table applications which have been registered as LTI Advantage platforms.

Parameters
array$registrationsThe list of registrations to render.
Return values
stringthe html.

◆ render_cookies_required_notice()

enrol_lti\output\renderer::render_cookies_required_notice ( )

Render a warning, indicating to the user that cookies are require but couldn't be set.

Return values
stringthe html.

◆ render_published_resource_selection_view()

enrol_lti\output\renderer::render_published_resource_selection_view ( LtiMessageLaunch $launch,
array $resources )

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.

Parameters
LtiMessageLaunch$launchthe launch data.
array$resourcesarray of published resources available to the current user.
Return values
stringhtml

◆ render_registration()

enrol_lti\output\renderer::render_registration ( registration $registration)

Render the enrol_lti/proxy_registration template.

Parameters
registration$registrationThe registration renderable
Return values
stringhtml for the page

◆ render_registration_view()

enrol_lti\output\renderer::render_registration_view ( int $registrationid,
string $activetab = '' )

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.
Parameters
int$registrationidthe id of the registration to display information for.
string$activetaba string identifying the tab to preselect when rendering.
Return values
bool|string
Exceptions
coding_exception
moodle_exception

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