enrol_lti

Topics
	privacy
	test

Directories
directory	backup
directory	local

Namespaces
namespace	enrol_lti
	Extends the IMS Tool provider library data connector for moodle.
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
	Tool registration page class.
namespace	enrol_lti\task
	Handles synchronising grades for the enrolment LTI.

Classes
class	backup_enrol_lti_plugin
	Define all the backup steps. More...
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
	The admin_setting_registeredplatforms class, for rendering a table of platforms which have been registered. More...
class	enrol_lti\local\ltiadvantage\entity\ags_info
	The ags_info class, instances of which represent grade service information for a resource_link or context. More...
class	enrol_lti\local\ltiadvantage\entity\application_registration
	Class application_registration. More...
class	enrol_lti\local\ltiadvantage\entity\context
	Class context, instances of which represent a context in the platform. More...
class	enrol_lti\local\ltiadvantage\entity\deployment
	Class deployment. More...
class	enrol_lti\local\ltiadvantage\entity\migration_claim
	The migration_claim class, instances of which represent information passed in an 'lti1p1' migration claim. More...
class	enrol_lti\local\ltiadvantage\entity\nrps_info
	Class nrps_info, instances of which represent a names and roles provisioning service for a resource. More...
class	enrol_lti\local\ltiadvantage\entity\resource_link
	Class resource_link. More...
class	enrol_lti\local\ltiadvantage\entity\user
	Class user, instances of which represent a specific lti user in the tool. More...
class	enrol_lti\local\ltiadvantage\form\create_registration_form
	The create_registration_form class, for creating a new pending platform registration. More...
class	enrol_lti\local\ltiadvantage\form\deployment_form
	The deployment_form class, for registering a deployment for a registered platform. More...
class	enrol_lti\local\ltiadvantage\form\platform_registration_form
	The platform_registration_form class, for registering a platform as a consumer of a published tool. More...
class	enrol_lti\local\ltiadvantage\lib\issuer_database
	The issuer_database class, providing a read-only store of issuer details. More...
class	enrol_lti\local\ltiadvantage\lib\launch_cache_session
	The launch_cache_session, providing a temporary session store for launch information. More...
class	enrol_lti\local\ltiadvantage\repository\application_registration_repository
	Class application_registration_repository. More...
class	enrol_lti\local\ltiadvantage\repository\context_repository
	Class context_repository. More...
class	enrol_lti\local\ltiadvantage\repository\deployment_repository
	The deployment_repository class. More...
class	enrol_lti\local\ltiadvantage\repository\legacy_consumer_repository
	The legacy_consumer_repository class, instances of which are responsible for querying LTI 1.1/2.0 consumer info. More...
class	enrol_lti\local\ltiadvantage\repository\published_resource_repository
	Class published_resource_repository for fetching the published_resource instances from the store. More...
class	enrol_lti\local\ltiadvantage\repository\resource_link_repository
	Class resource_link_repository. More...
class	enrol_lti\local\ltiadvantage\repository\user_repository
	Class user_repository. More...
class	enrol_lti\local\ltiadvantage\service\application_registration_service
	Class application_registration_service. More...
class	enrol_lti\local\ltiadvantage\service\tool_deployment_service
	Class tool_deployment_service. More...
class	enrol_lti\local\ltiadvantage\service\tool_launch_service
	Class tool_launch_service. More...
class	enrol_lti\local\ltiadvantage\table\published_resources_table
	Class which displays a list of resources published over LTI Advantage. More...
class	enrol_lti\local\ltiadvantage\task\sync_grades
	LTI Advantage task responsible for pushing grades to tool platforms. More...
class	enrol_lti\local\ltiadvantage\task\sync_members
	LTI Advantage-specific task responsible for syncing memberships from tool platforms with the tool. More...
class	enrol_lti\local\ltiadvantage\task\sync_tool_grades
	LTI Advantage task responsible for pushing grades to tool platforms. More...
class	enrol_lti\local\ltiadvantage\utility\message_helper
	Utility class for LTI Advantage messages. More...
class	enrol_lti\local\ltiadvantage\viewobject\published_resource
	The class published_resource, instances of which represent a specific VIEW of a published resource. More...
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\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_plugin
	LTI enrolment plugin class. More...
class	lti_advantage_testcase
	Parent class for LTI Advantage tests, providing environment setup and mock user launches. More...
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::$CFG
global	enrol_lti\local\ltiadvantage\table::$CFG
	$plugin = 2023100400
	$settings = new admin_settingpage($section, "User default values", 'moodle/site:config', $this->is_enabled() === false)
	$tasks
	Enrol LTI tasks.
$plugin	component = 'enrol_lti'
$plugin	dependencies
$plugin	version = 2023100900

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,
        )
    ),
)

$tasks

$tasks

Enrol LTI tasks.

Copyright

2016 Mark Nelson markn.nosp@m.@moo.nosp@m.dle.c.nosp@m.om

License

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

dependencies

$plugin dependencies

Initial value:

= [
    'auth_lti' => 2023100400, 
]