Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
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.
 
 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 ($headinglevel=1)
 Whether we should display the 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

◆ __call()

plugin_renderer_base::__call ( $method,
$arguments )
inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters
string$method
array$arguments
Return values
mixed

◆ add_action_handler()

renderer_base::add_action_handler ( component_action $action,
$id = null )
inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters
component_action$action
string$id
Return values
stringid of element, either original submitted or random new if not supplied

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url ( $maxwidth = 300,
$maxheight = 300 )
inherited

Return the site's compact logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url ( $maxwidth = null,
$maxheight = 200 )
inherited

Return the site's logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )
protectedinherited

Return an instance of the mustache class.

Since
2.9
Return values
Mustache_Engine

◆ has_started()

renderer_base::has_started ( )
inherited

Returns true is output has already started, and false if not.

Return values
booleantrue if the header has been printed.

◆ image_url()

renderer_base::image_url ( $imagename,
$component = 'moodle' )
inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters
string$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ pix_url()

renderer_base::pix_url ( $imagename,
$component = 'moodle' )
inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated
since Moodle 3.3
Parameters
string$imagenamethe name of the icon.
string$componentspecification of one plugin like in get_string()
Return values
moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes)
staticinherited

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

Parameters
mixed$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable $widget)
inherited

Renders the provided widget and returns the HTML to display it.

Parameters
renderable$widgetinstance with renderable interface
Return values
string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ 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_from_template()

renderer_base::render_from_template ( $templatename,
$context )
inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since
2.9
Parameters
array | stdClass$contextContext containing data for the template.
Return values
string|boolean

◆ 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

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1)
inherited

Whether we should display the main logo.

Deprecated
since Moodle 4.0
Todo
final deprecation. To be removed in Moodle 4.4 MDL-73165.
Parameters
int$headinglevelThe heading level we want to check against.
Return values
bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )
inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values
bool

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output
protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer


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