Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
enrol_lti

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::$CFG
 
global enrol_lti\local\ltiadvantage\table::$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$navigationThe settings navigation object
stdClass$courseThe course
stdclass$contextCourse 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$cmThe 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
stringA 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$oldversionNew 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,
)
),
)
const CONTEXT_COURSE
Course context level - one instances for each course.
Definition accesslib.php:128
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition accesslib.php:115

◆ dependencies

$plugin dependencies
Initial value:
= [
'auth_lti' => 2023041800,
]