enrol_lti

Directories
directory	backup
directory	local

Files
file	access.php
	Capabilities for LTI enrolment plugin.
file	admin_setting_registeredplatforms.php
	The admin_setting_registeredplatforms class, for rendering a table of platforms which have been registered.
file	ags_info.php
	The ags_info class, instances of which represent grade service information for a resource_link or context.
file	application_registration.php
	Class application_registration.
file	application_registration_repository.php
	Class application_registration_repository.
file	application_registration_service.php
	Class application_registration_service.
file	backup_enrol_lti_plugin.class.php
	Defines the backup_enrol_lti_plugin class.
file	behat_enrol_lti_generator.php
	Behat data generator for enrol_lti.
file	context.php
	Class context, instances of which represent a context in the platform.
file	context_repository.php
	Class context_repository.
file	create_registration_form.php
	The create_registration_form class, for creating a new pending platform registration.
file	data_connector.php
	Extends the IMS Tool provider library data connector for moodle.
file	deployment.php
	Class deployment.
file	deployment_form.php
	The deployment_form class, for registering a deployment for a registered platform.
file	deployment_repository.php
	The deployment_repository class.
file	helper.php
	LTI enrolment plugin helper.
file	install.php
	Post installation code for enrol_lti.
file	issuer_database.php
	The issuer_database class, providing a read-only store of issuer details.
file	launch_cache_session.php
	The launch_cache_session, providing a temporary session store for launch information.
file	legacy_consumer_repository.php
	The legacy_consumer_repository class, instances of which are responsible for querying LTI 1.1/2.0 consumer info.
file	lib.php
	LTI enrolment plugin main library file.
file	lib.php
	LTI Enrolment test data generator class.
file	lti_advantage_testcase.php
	Parent class for LTI Advantage tests, providing environment setup and mock user launches.
file	manage_table.php
	Displays enrolment LTI instances.
file	message_helper.php
	Utility class for LTI Advantage messages.
file	migration_claim.php
	The migration_claim class, instances of which represent information passed in an 'lti1p1' migration claim.
file	nrps_info.php
	Class nrps_info, instances of which represent a names and roles provisioning service for a resource.
file	platform_registration_form.php
	The platform_registration_form class, for registering a platform as a consumer of a published tool.
file	provider.php
	Privacy Subsystem implementation for enrol_lti.
file	published_resource.php
	The class published_resource, instances of which represent a specific VIEW of a published resource.
file	published_resource_repository.php
	Class published_resource_repository for fetching the published_resource instances from the store.
file	published_resources_table.php
	Class which displays a list of resources published over LTI Advantage.
file	registration.php
	Tool registration page class.
file	renderer.php
	Renderer class for LTI enrolment.
file	resource_link.php
	Class resource_link.
file	resource_link_repository.php
	Class resource_link_repository.
file	restore_enrol_lti_plugin.class.php
	Defines the restore_enrol_lti_plugin class.
file	settings.php
	General plugin functions.
file	sync_grades.php
	LTI Advantage task responsible for pushing grades to tool platforms.
file	sync_grades.php
	Handles synchronising grades for the enrolment LTI.
file	sync_members.php
	LTI Advantage-specific task responsible for syncing memberships from tool platforms with the tool.
file	sync_members.php
	Handles synchronising members using the enrolment LTI.
file	sync_tool_grades.php
	LTI Advantage task responsible for pushing grades to tool platforms.
file	tasks.php
	Enrol LTI tasks.
file	tool_deployment_service.php
	Class tool_deployment_service.
file	tool_launch_service.php
	Class tool_launch_service.
file	tool_provider.php
	Extends the IMS Tool provider library for the LTI enrolment.
file	upgrade.php
	This file keeps track of upgrades to the lti enrolment plugin.
file	upgradelib.php
	This file contains functions used by upgrade and install.
file	user.php
	Class user, instances of which represent a specific lti user in the tool.
file	user_repository.php
	Class user_repository.
file	version.php
	LTI enrolment plugin version information.

Namespaces
namespace	enrol_lti
namespace	enrol_lti\local\ltiadvantage\admin
namespace	enrol_lti\local\ltiadvantage\entity
namespace	enrol_lti\local\ltiadvantage\form
namespace	enrol_lti\local\ltiadvantage\lib
namespace	enrol_lti\local\ltiadvantage\repository
namespace	enrol_lti\local\ltiadvantage\service
namespace	enrol_lti\local\ltiadvantage\table
namespace	enrol_lti\local\ltiadvantage\task
namespace	enrol_lti\local\ltiadvantage\utility
namespace	enrol_lti\local\ltiadvantage\viewobject
namespace	enrol_lti\output
namespace	enrol_lti\privacy
namespace	enrol_lti\task

Classes
class	backup_enrol_lti_plugin
	Define all the backup steps. More...
class	behat_enrol_lti_generator
class	enrol_lti\data_connector
	Extends the IMS Tool provider library data connector for moodle. More...
class	enrol_lti\helper
	LTI enrolment plugin helper class. More...
class	enrol_lti\local\ltiadvantage\admin\admin_setting_registeredplatforms
class	enrol_lti\local\ltiadvantage\entity\ags_info
class	enrol_lti\local\ltiadvantage\entity\application_registration
class	enrol_lti\local\ltiadvantage\entity\context
class	enrol_lti\local\ltiadvantage\entity\deployment
class	enrol_lti\local\ltiadvantage\entity\migration_claim
class	enrol_lti\local\ltiadvantage\entity\nrps_info
class	enrol_lti\local\ltiadvantage\entity\resource_link
class	enrol_lti\local\ltiadvantage\entity\user
class	enrol_lti\local\ltiadvantage\form\create_registration_form
class	enrol_lti\local\ltiadvantage\form\deployment_form
class	enrol_lti\local\ltiadvantage\form\platform_registration_form
class	enrol_lti\local\ltiadvantage\lib\issuer_database
class	enrol_lti\local\ltiadvantage\lib\launch_cache_session
class	enrol_lti\local\ltiadvantage\repository\application_registration_repository
class	enrol_lti\local\ltiadvantage\repository\context_repository
class	enrol_lti\local\ltiadvantage\repository\deployment_repository
class	enrol_lti\local\ltiadvantage\repository\legacy_consumer_repository
class	enrol_lti\local\ltiadvantage\repository\published_resource_repository
class	enrol_lti\local\ltiadvantage\repository\resource_link_repository
class	enrol_lti\local\ltiadvantage\repository\user_repository
class	enrol_lti\local\ltiadvantage\service\application_registration_service
class	enrol_lti\local\ltiadvantage\service\tool_deployment_service
class	enrol_lti\local\ltiadvantage\service\tool_launch_service
class	enrol_lti\local\ltiadvantage\table\published_resources_table
class	enrol_lti\local\ltiadvantage\task\sync_grades
class	enrol_lti\local\ltiadvantage\task\sync_members
class	enrol_lti\local\ltiadvantage\task\sync_tool_grades
class	enrol_lti\local\ltiadvantage\utility\message_helper
class	enrol_lti\local\ltiadvantage\viewobject\published_resource
class	enrol_lti\manage_table
	Handles displaying enrolment LTI instances. More...
class	enrol_lti\output\registration
	Tool registration page class. More...
class	enrol_lti\output\renderer
	Renderer class for LTI enrolment. More...
class	enrol_lti\privacy\provider
	Privacy Subsystem for enrol_lti. More...
class	enrol_lti\task\sync_grades
	Task for synchronising grades for the enrolment LTI. More...
class	enrol_lti\task\sync_members
	Task for synchronising members using the enrolment LTI. More...
class	enrol_lti\tool_provider
	Extends the IMS Tool provider library for the LTI enrolment. More...
class	enrol_lti_generator
class	enrol_lti_plugin
	LTI enrolment plugin class. More...
class	lti_advantage_testcase
class	restore_enrol_lti_plugin
	Define all the restore steps. More...

Functions
	enrol_lti_extend_navigation_course ($navigation, $course, $context)
	Display the LTI link in the course administration menu.
	enrol_lti_get_fontawesome_icon_map ()
	Get icon mapping for font-awesome.
	enrol_lti_pre_course_module_delete (stdClass $cm)
	Pre-delete course module hook which disables any methods referring to the deleted module, preventing launches and allowing remap.
	enrol_lti_verify_private_key ()
	This function checks if a private key has been generated for this enrolment instance.
	xmldb_enrol_lti_install ()
	Stub for database installation.
	xmldb_enrol_lti_upgrade ($oldversion)
	xmldb_lti_upgrade is the function that upgrades the lti module database when is needed

Variables
	$capabilities
global	enrol_lti\local\ltiadvantage\table::$CFG
global	enrol_lti::$CFG
	$plugin = 2023041800
	$settings = new admin_settingpage($section, "User default values", 'moodle/site:config', $this->is_enabled() === false)
	$tasks
$plugin	component = 'enrol_lti'
$plugin	dependencies
$plugin	version = 2023042400

Detailed Description

Function Documentation

enrol_lti_extend_navigation_course()

enrol_lti_extend_navigation_course	(		$navigation,
			$course,
			$context
	)

Display the LTI link in the course administration menu.

Parameters

settings_navigation	$navigation	The settings navigation object
stdClass	$course	The course
stdclass	$context	Course context

enrol_lti_pre_course_module_delete()

enrol_lti_pre_course_module_delete

(

stdClass

$cm

)

Pre-delete course module hook which disables any methods referring to the deleted module, preventing launches and allowing remap.

Parameters

stdClass

$cm

The deleted course module record.

enrol_lti_verify_private_key()

enrol_lti_verify_private_key

(

)

This function checks if a private key has been generated for this enrolment instance.

If the key does not exist it generates a new one. If the openssl extension is not installed or configured properly it returns a warning message.

Return values

string

A warning message if a private key does not exist and cannot be generated.

xmldb_enrol_lti_upgrade()

xmldb_enrol_lti_upgrade

(

$oldversion

)

xmldb_lti_upgrade is the function that upgrades the lti module database when is needed

This function is automaticly called when version number in version.php changes.

Parameters

int

$oldversion

New old version number.

Return values

boolean

Variable Documentation

$capabilities

$capabilities

Initial value:

= array(
 
    
    'enrol/lti:config' => array(
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'manager' => CAP_ALLOW,
            'editingteacher' => CAP_ALLOW,
        )
    ),
 
    'enrol/lti:unenrol' => array(
        'captype' => 'write',
        'contextlevel' => CONTEXT_COURSE,
        'archetypes' => array(
            'manager' => CAP_ALLOW,
            'editingteacher' => CAP_ALLOW,
        )
    ),
)

dependencies

$plugin dependencies

Initial value:

= [
    'auth_lti' => 2023041800, 
]