Inheritance diagram for auth_plugin_lti:

Public Member Functions
	__construct ()
	Constructor.

	can_be_manually_set ()
	Returns whether or not this authentication plugin can be manually set for users, for example, when bulk uploading users.

	can_change_password ()
	Returns true if this authentication plugin can change the users' password.

	can_confirm ()
	Returns true if plugin allows confirming of new users.

	can_edit_profile ()
	Returns true if this authentication plugin can edit the users' profile.

	can_reset_password ()
	Returns true if plugin allows resetting of internal password.

	can_signup ()
	Returns true if plugin allows resetting of internal password.

	change_password_url ()
	Returns the URL for changing the users' passwords, or empty if the default URL can be used.

	complete_login (array $launchdata, moodle_url $returnurl, int $provisioningmode, array $legacyconsumersecrets=[])
	Authenticate the user based on the unique {iss, sub} tuple present in the OIDC JWT.

	config_form ($config, $err, $user_fields)
	Prints a form for configuring this authentication plugin.

	create_user_binding (string $iss, string $sub, int $userid)
	Create a binding between the LTI user, as identified by {iss, sub} tuple and the user id.

	edit_profile_url ()
	Returns the URL for editing the users' profile, or empty if the default URL can be used.

	find_cli_user ()
	Identify a Moodle account on the CLI.

	find_or_create_user_from_launch (array $launchdata, array $legacyconsumersecrets=[])
	Get a Moodle user account for the LTI user corresponding to the user defined in a link launch.

	find_or_create_user_from_membership (array $member, string $iss, string $legacyconsumerkey='')
	Get a Moodle user account for the LTI user based on the user details returned by a NRPS 2 membership call.

	get_custom_user_profile_fields ()
	Return custom user profile fields.

	get_description ()
	Get the auth description (from core or own auth lang files)

	get_extrauserinfo ()
	Returns extra user information.

	get_password_change_info (stdClass $user)
	Returns information on how the specified user can change their password.

	get_title ()
	Return the properly translated human-friendly title of this auth plugin.

	get_user_binding (string $issuer, string $sub)
	Gets the id of the linked Moodle user account for an LTI user, or null if not found.

	get_userinfo ($username)
	Read user information from external database and returns it as array().

	ignore_timeout_hook ($user, $sid, $timecreated, $timemodified)
	Hook called before timing out of database session.

	is_captcha_enabled ()
	Returns whether or not the captcha element is enabled.

	is_configured ()
	Returns false if this plugin is enabled but not configured.

	is_internal ()
	Returns true if this authentication plugin is "internal".

	is_synchronised_with_external ()
	Indicates if moodle should automatically update internal user records with data from external sources using the information from get_userinfo() method.

object	loginpage_hook ()
	Hook for overriding behaviour of login page.

	loginpage_idp_list ($wantsurl)
	Returns a list of potential IdPs that this authentication plugin supports.

object	logoutpage_hook ()
	Hook for overriding behaviour of logout page.

	password_expire ($username)
	return number of days to user password expires

	postlogout_hook ($user)
	Post logout hook.

	pre_loginpage_hook ()
	Hook for overriding behaviour before going to the login page.

	pre_user_login_hook (&$user)
	Pre user_login hook.

object	prelogout_hook ()
	Pre logout hook.

	prevent_local_passwords ()
	Indicates if password hashes should be stored in local moodle database.

	process_config ($config)
	Processes and stores configuration data for this authentication plugin.

	set_extrauserinfo (array $values)
	Set extra user information.

	signup_form ()
	Return a form to capture user details for account creation.

	sync_roles ($user)
	Sync roles for this user - usually creator.

	update_user_account (stdClass $user, array $userdata, string $iss)
	Update the personal fields of the user account, based on data present in either a launch of member sync call.

	user_authenticated_hook (&$user, $username, $password)
	Post authentication hook.

	user_confirm ($username, $confirmsecret)
	Confirm the new user as registered.

	user_delete ($olduser)
	User delete requested - internal user record is mared as deleted already, username not present anymore.

	user_exists ($username)
	Checks if user exists in external db.

	user_login ($username, $password)
	Users can not log in via the traditional login form.

	user_signup ($user, $notify=true)
	Sign up a new user ready for confirmation.

	user_update ($olduser, $newuser)
	Called when the user record is updated.

	user_update_password ($user, $newpassword)
	Updates the user's password.

	validate_form ($form, &$err)
	A chance to validate form data, and last chance to do stuff before it is inserted in config_plugin.

Static Public Member Functions
static	find_cli_admin_user ()
	Find an OS level admin Moodle user account.

static	get_enabled_auth_plugin_classes ()
	Returns the enabled auth plugins.

static	get_identity_providers ($authsequence)
	Return the list of enabled identity providers.

static	login_cli_admin_user ()
	Find and login as an OS level admin Moodle user account.

static	prepare_identity_providers_for_output ($identityproviders, renderer_base $output)
	Prepare a list of identity providers for output.

Public Attributes
string	$authtype
	Authentication plugin type - the same as db field.

object	$config
	The configuration details for the plugin.

array	$userfields = core_user::AUTHSYNCFIELDS

int const	PROVISIONING_MODE_AUTO_ONLY = 1
	constant representing the automatic account provisioning mode.

int const	PROVISIONING_MODE_PROMPT_EXISTING_ONLY = 3
	constant representing the prompt for existing only provisioning mode.

int const	PROVISIONING_MODE_PROMPT_NEW_EXISTING = 2
	constant representing the prompt for new or existing provisioning mode.

Protected Member Functions
	create_new_account (array $userdata, string $iss)
	Create a new user account based on the user data either in the launch JWT or from a membership call.

	empty_session ()
	If there's an existing session, inits an empty session.

	is_valid_provisioning_mode (int $mode)
	Check whether a provisioning mode is valid or not.

	update_user_picture (int $userid, string $url)
	Update the user's picture with the image stored at $url.

	update_user_record ($username, $updatekeys=false, $triggerevent=false, $suspenduser=false)
	Update a local user record from an external source.

Protected Attributes
string	$errorlogtag = ''
	The tag we want to prepend to any error log messages.

array	$extrauserinfo = []
	Stores extra information available to the logged in event.

Member Function Documentation

◆ can_be_manually_set()

auth_plugin_base::can_be_manually_set ( )

inherited

Returns whether or not this authentication plugin can be manually set for users, for example, when bulk uploading users.

This should be overriden by authentication plugins where setting the authentication method manually is allowed.

Return values

bool

Since: Moodle 2.6

Reimplemented in auth_oauth2\auth, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_nologin, and auth_plugin_none.

◆ can_change_password()

auth_plugin_base::can_change_password ( )

inherited

Returns true if this authentication plugin can change the users' password.

Return values

bool

Reimplemented in auth_oauth2\auth, auth_plugin_cas, auth_plugin_db, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_mnet, auth_plugin_nologin, auth_plugin_none, auth_plugin_shibboleth, and auth_plugin_webservice.

◆ can_confirm()

auth_plugin_base::can_confirm ( )

inherited

Returns true if plugin allows confirming of new users.

Return values

bool

Reimplemented in auth_plugin_email, and auth_plugin_ldap.

◆ can_edit_profile()

auth_plugin_base::can_edit_profile ( )

inherited

Returns true if this authentication plugin can edit the users' profile.

Return values

bool

◆ can_reset_password()

auth_plugin_base::can_reset_password ( )

inherited

Returns true if plugin allows resetting of internal password.

Return values

bool

Reimplemented in auth_oauth2\auth, auth_plugin_db, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_nologin, auth_plugin_none, and auth_plugin_webservice.

◆ can_signup()

auth_plugin_base::can_signup ( )

inherited

Returns true if plugin allows resetting of internal password.

Return values

bool

Reimplemented in auth_plugin_email, and auth_plugin_ldap.

◆ change_password_url()

auth_plugin_base::change_password_url ( )

inherited

Returns the URL for changing the users' passwords, or empty if the default URL can be used.

This method is used if can_change_password() returns true. This method is called only when user is logged in, it may use global $USER. If you are using a plugin config variable in this method, please make sure it is set before using it, as this method can be called even if the plugin is disabled, in which case the config values won't be set.

Return values

?moodle_url url of the profile page or null if standard used

Reimplemented in auth_oauth2\auth, auth_plugin_cas, auth_plugin_db, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_mnet, auth_plugin_none, auth_plugin_shibboleth, and auth_plugin_webservice.

◆ complete_login()

auth_plugin_lti::complete_login	(	array	$launchdata,
		moodle_url	$returnurl,
		int	$provisioningmode,
		array	$legacyconsumersecrets = [] )

Authenticate the user based on the unique {iss, sub} tuple present in the OIDC JWT.

This method ensures a Moodle user account has been found or is created, that the user is linked to the relevant LTI Advantage credentials (iss, sub) and that the user account is logged in.

Launch code can therefore rely on this method to get a session before doing things like calling require_login().

This method supports two workflows:

Automatic account provisioning - where the complete_login() call will ALWAYS create/find a user and return to calling code directly. No user interaction is required.
Manual account provisioning - where the complete_login() call will redirect ONLY ONCE to a login page, where the user can decide whether to use an automatically provisioned account, or bind an existing user account. When the decision has been made, the relevant account is bound and the user is redirected back to $returnurl. Once an account has been bound via this selection process, subsequent calls to complete_login() will return to calling code directly. Any calling code must provide its $returnurl to support the return from the account selection process and must also take care to cache any JWT data appropriately, since the return will not inlude that information.

Which workflow is chosen depends on the roles present in the JWT. For teachers/admins, manual provisioning will take place. These user type are likely to have existing accounts. For learners, automatic provisioning will take place.

Migration of legacy users is supported, however, only for the Learner role (automatic provisioning). Admins and teachers are likely to have existing accounts and we want them to be able to select and bind these, rather than binding an automatically provisioned legacy account which doesn't represent their real user account.

The JWT data must be verified elsewhere. The code here assumes its integrity/authenticity.

Parameters

array	$launchdata	the JWT data provided in the link launch.
moodle_url	$returnurl	the local URL to return to if authentication workflows are required.
int	$provisioningmode	the desired account provisioning mode, which controls the auth flow for unbound users.
array	$legacyconsumersecrets	an array of secrets used by the legacy consumer if a migration claim exists.

Exceptions

coding_exception if the specified provisioning mode is invalid.

◆ config_form()

auth_plugin_base::config_form	(	$config,
		$err,
		$user_fields )

inherited

Prints a form for configuring this authentication plugin.

This function is called from admin/auth.php, and outputs a full page with a form for configuring this plugin.

Parameters

object	$config
object	$err
array	$user_fields

Deprecated: since Moodle 3.3

◆ create_new_account()

auth_plugin_lti::create_new_account	(	array	$userdata,
		string	$iss )

protected

Create a new user account based on the user data either in the launch JWT or from a membership call.

Parameters

array	$userdata	the user data coming from either a launch or membership service call.
string	$iss	the issuer to which the user belongs.

Return values

stdClass a complete Moodle user record.

◆ create_user_binding()

auth_plugin_lti::create_user_binding	(	string	$iss,
		string	$sub,
		int	$userid )

Create a binding between the LTI user, as identified by {iss, sub} tuple and the user id.

Parameters

string	$iss	the issuer URL identifying the platform to which to user belongs.
string	$sub	the sub string identifying the user on the platform.
int	$userid	the id of the Moodle user account to bind.

◆ edit_profile_url()

auth_plugin_base::edit_profile_url ( )

inherited

Returns the URL for editing the users' profile, or empty if the default URL can be used.

This method is used if can_edit_profile() returns true. This method is called only when user is logged in, it may use global $USER.

Return values

?moodle_url url of the profile page or null if standard used

◆ empty_session()

auth_plugin_lti::empty_session ( )

protected

If there's an existing session, inits an empty session.

Return values

void

◆ find_cli_admin_user()

static auth_plugin_base::find_cli_admin_user ( )

staticinherited

Find an OS level admin Moodle user account.

Used when running CLI scripts. Only accounts which are site admin will be accepted.

Return values

null|stdClass Admin user record if found

◆ find_cli_user()

auth_plugin_base::find_cli_user ( )

inherited

Identify a Moodle account on the CLI.

For example a plugin might use posix_geteuid and posix_getpwuid to find the username of the OS level user and then match that against Moodle user accounts.

Return values

null|stdClass User user record if found

◆ find_or_create_user_from_launch()

auth_plugin_lti::find_or_create_user_from_launch	(	array	$launchdata,
		array	$legacyconsumersecrets = [] )

Get a Moodle user account for the LTI user corresponding to the user defined in a link launch.

This method supports migration of user accounts used in legacy launches, provided the legacy consumer secrets corresponding to the legacy consumer are provided. If calling code wishes migration to be role-specific, it should check roles accordingly itself and pass relevant data in - as auth_plugin_lti\complete_login() does.

Parameters

array	$launchdata	all data in the decoded JWT including iss and sub.
array	$legacyconsumersecrets	all secrets found for the legacy consumer, facilitating user migration.

Return values

stdClass the Moodle user who is mapped to the platform user identified in the JWT data.

◆ find_or_create_user_from_membership()

auth_plugin_lti::find_or_create_user_from_membership	(	array	$member,
		string	$iss,
		string	$legacyconsumerkey = '' )

Get a Moodle user account for the LTI user based on the user details returned by a NRPS 2 membership call.

This method expects a single member structure, in array format, as defined here: See: https://www.imsglobal.org/spec/lti-nrps/v2p0#membership-container-media-type.

This method supports migration of user accounts used in legacy launches, provided the legacy consumerkey corresponding to to the legacy consumer is provided. Calling code will have verified the migration claim during initial launches and should have the consumer key mapped to the deployment, ready to pass in.

Parameters

array	$member	the member data, in array format.
string	$iss	the issuer to which the member relates.
string	$legacyconsumerkey	optional consumer key mapped to the deployment to facilitate user migration.

Return values

stdClass a Moodle user record.

◆ get_custom_user_profile_fields()

auth_plugin_base::get_custom_user_profile_fields ( )

inherited

Return custom user profile fields.

Return values

array list of custom fields.

◆ get_description()

auth_plugin_base::get_description ( )

inherited

Get the auth description (from core or own auth lang files)

Return values

string The description

◆ get_enabled_auth_plugin_classes()

static auth_plugin_base::get_enabled_auth_plugin_classes ( )

staticinherited

Returns the enabled auth plugins.

Return values

array of plugin classes

◆ get_extrauserinfo()

auth_plugin_base::get_extrauserinfo ( )

inherited

Returns extra user information.

Return values

array An array of keys and values

◆ get_identity_providers()

static auth_plugin_base::get_identity_providers ( $authsequence )

staticinherited

Return the list of enabled identity providers.

Each identity provider data contains the keys url, name and iconurl (or icon). See the documentation of auth_plugin_base::loginpage_idp_list() for detailed description of the returned structure.

Parameters

array $authsequence site's auth sequence (list of auth plugins ordered)

Return values

array List of arrays describing the identity providers

◆ get_password_change_info()

auth_plugin_base::get_password_change_info ( stdClass $user )

inherited

Returns information on how the specified user can change their password.

Parameters

stdClass $user A user object

Return values

string[] An array of strings with keys subject and message

Reimplemented in auth_oauth2\auth, and auth_plugin_nologin.

◆ get_title()

auth_plugin_base::get_title ( )

inherited

Return the properly translated human-friendly title of this auth plugin.

Todo: Document this function

◆ get_user_binding()

auth_plugin_lti::get_user_binding	(	string	$issuer,
		string	$sub )

Gets the id of the linked Moodle user account for an LTI user, or null if not found.

Parameters

string	$issuer	the issuer to which the user belongs.
string	$sub	the sub string identifying the user on the issuer.

Return values

int|null the id of the corresponding Moodle user record, or null if not found.

◆ get_userinfo()

auth_plugin_base::get_userinfo ( $username )

inherited

Read user information from external database and returns it as array().

Function should return all information available. If you are saving this information to moodle user-table you should honour synchronisation flags

Parameters

string $username username

Return values

mixed array with no magic quotes or false on error

Reimplemented in auth_oauth2\auth, auth_plugin_cas, auth_plugin_db, auth_plugin_ldap, and auth_plugin_shibboleth.

◆ ignore_timeout_hook()

auth_plugin_base::ignore_timeout_hook	(	$user,
		$sid,
		$timecreated,
		$timemodified )

inherited

Hook called before timing out of database session.

This is useful for SSO and MNET.

Parameters

object	$user
string	$sid	session id
int	$timecreated	start of session
int	$timemodified	user last seen

Return values

bool	true means do not timeout session yet

◆ is_captcha_enabled()

auth_plugin_base::is_captcha_enabled ( )

inherited

Returns whether or not the captcha element is enabled.

@abstract Implement in child classes

Return values

bool

Reimplemented in auth_plugin_email.

◆ is_configured()

auth_plugin_base::is_configured ( )

inherited

Returns false if this plugin is enabled but not configured.

Return values

bool

Reimplemented in auth_plugin_db.

◆ is_internal()

auth_plugin_base::is_internal ( )

inherited

Returns true if this authentication plugin is "internal".

Internal plugins use password hashes from Moodle user table for authentication.

Return values

bool

Reimplemented in auth_oauth2\auth, auth_plugin_cas, auth_plugin_db, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_mnet, auth_plugin_nologin, auth_plugin_none, auth_plugin_shibboleth, and auth_plugin_webservice.

◆ is_synchronised_with_external()

auth_plugin_base::is_synchronised_with_external ( )

inherited

Indicates if moodle should automatically update internal user records with data from external sources using the information from get_userinfo() method.

Return values

bool	true means automatically copy data from ext to user table

Reimplemented in auth_oauth2\auth, and auth_plugin_db.

◆ is_valid_provisioning_mode()

auth_plugin_lti::is_valid_provisioning_mode ( int $mode )

protected

Check whether a provisioning mode is valid or not.

Parameters

int $mode the mode

Return values

bool	true if valid for use, false otherwise.

◆ login_cli_admin_user()

static auth_plugin_base::login_cli_admin_user ( )

staticinherited

Find and login as an OS level admin Moodle user account.

Used for running CLI scripts which must be admin accounts.

◆ loginpage_hook()

object auth_plugin_base::loginpage_hook ( )

inherited

Hook for overriding behaviour of login page.

This method is called from login/index.php page for all enabled auth plugins.

@global object

Reimplemented in auth_plugin_cas, auth_plugin_ldap, and auth_plugin_shibboleth.

◆ loginpage_idp_list()

auth_plugin_base::loginpage_idp_list ( $wantsurl )

inherited

Returns a list of potential IdPs that this authentication plugin supports.

This is used to provide links on the login page and the login block.

The parameter $wantsurl is typically used by the plugin to implement a return-url feature.

The returned value is expected to be a list of associative arrays with string keys:

url => (moodle_url|string) URL of the page to send the user to for authentication
name => (string) Human readable name of the IdP
iconurl => (moodle_url|string) URL of the icon representing the IdP (since Moodle 3.3)

For legacy reasons, pre-3.3 plugins can provide the icon via the key:

icon => (pix_icon) Icon representing the IdP

Parameters

string $wantsurl The relative url fragment the user wants to get to.

Return values

array List of associative arrays with keys url, name, iconurl|icon

Reimplemented in auth_oauth2\auth, auth_plugin_cas, auth_plugin_mnet, and auth_plugin_shibboleth.

◆ logoutpage_hook()

object auth_plugin_base::logoutpage_hook ( )

inherited

Hook for overriding behaviour of logout page.

This method is called from login/logout.php page for all enabled auth plugins.

@global string

Reimplemented in auth_plugin_cas, auth_plugin_mnet, and auth_plugin_shibboleth.

◆ password_expire()

auth_plugin_base::password_expire ( $username )

inherited

return number of days to user password expires

If userpassword does not expire it should return 0. If password is already expired it should return negative value.

Parameters

mixed $username username (with system magic quotes)

Return values

integer

Reimplemented in auth_plugin_ldap, and auth_plugin_manual.

◆ postlogout_hook()

auth_plugin_base::postlogout_hook ( $user )

inherited

Post logout hook.

This method is used after moodle logout by auth classes to execute server logout.

Parameters

stdClass $user clone of USER object before the user session was terminated

Reimplemented in auth_plugin_cas.

◆ pre_loginpage_hook()

auth_plugin_base::pre_loginpage_hook ( )

inherited

Hook for overriding behaviour before going to the login page.

This method is called from require_login from potentially any page for all enabled auth plugins and gives each plugin a chance to redirect directly to an external login page, or to instantly login a user where possible.

If an auth plugin implements this hook, it must not rely on ONLY this hook in order to work, as there are many ways a user can browse directly to the standard login page. As a general rule in this case you should also implement the loginpage_hook as well.

◆ pre_user_login_hook()

auth_plugin_base::pre_user_login_hook ( & $user )

inherited

Pre user_login hook.

This method is called from authenticate_user_login() right after the user object is generated. This gives the auth plugins an option to make adjustments before the verification process starts.

Parameters

object $user user object, later used for $USER

◆ prelogout_hook()

object auth_plugin_base::prelogout_hook ( )

inherited

Pre logout hook.

This method is called from require_logout() for all enabled auth plugins,

Reimplemented in auth_plugin_mnet.

◆ prepare_identity_providers_for_output()

static auth_plugin_base::prepare_identity_providers_for_output	(		$identityproviders,
		renderer_base	$output )

staticinherited

Prepare a list of identity providers for output.

Parameters

array	$identityproviders	as returned by self::get_identity_providers()
renderer_base	$output

Return values

array the identity providers ready for output

◆ prevent_local_passwords()

auth_plugin_base::prevent_local_passwords ( )

inherited

Indicates if password hashes should be stored in local moodle database.

Return values

bool	true means md5 password hash stored in user table, false means flag 'not_cached' stored there instead

Reimplemented in auth_oauth2\auth, auth_plugin_cas, auth_plugin_db, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_mnet, auth_plugin_nologin, auth_plugin_none, and auth_plugin_shibboleth.

◆ process_config()

auth_plugin_base::process_config ( $config )

inherited

Processes and stores configuration data for this authentication plugin.

Parameters

object object with submitted configuration settings (without system magic quotes)

Deprecated: since Moodle 3.3

◆ set_extrauserinfo()

auth_plugin_base::set_extrauserinfo ( array $values )

inherited

Set extra user information.

Parameters

array $values Any Key value pair.

Return values

void

◆ signup_form()

auth_plugin_base::signup_form ( )

inherited

Return a form to capture user details for account creation.

This is used in /login/signup.php.

Return values

moodleform A form which edits a record from the user table.

◆ sync_roles()

auth_plugin_base::sync_roles ( $user )

inherited

Sync roles for this user - usually creator.

Parameters

$user object user object (without system magic quotes)

Reimplemented in auth_plugin_ldap.

◆ update_user_account()

auth_plugin_lti::update_user_account	(	stdClass	$user,
		array	$userdata,
		string	$iss )

Update the personal fields of the user account, based on data present in either a launch of member sync call.

Parameters

stdClass	$user	the Moodle user account to update.
array	$userdata	the user data coming from either a launch or membership service call.
string	$iss	the issuer to which the user belongs.

◆ update_user_picture()

auth_plugin_lti::update_user_picture	(	int	$userid,
		string	$url )

protected

Update the user's picture with the image stored at $url.

Parameters

int	$userid	the id of the user to update.
string	$url	the string URL where the new image can be found.

Exceptions

moodle_exception if there were any problems updating the picture.

◆ update_user_record()

auth_plugin_base::update_user_record	(	$username,
		$updatekeys = false,
		$triggerevent = false,
		$suspenduser = false )

protectedinherited

Update a local user record from an external source.

This is a lighter version of the one in moodlelib – won't do expensive ops such as enrolment.

Parameters

string	$username	username
array	$updatekeys	fields to update, false updates all fields.
bool	$triggerevent	set false if user_updated event should not be triggered. This will not affect user_password_updated event triggering.
bool	$suspenduser	Should the user be suspended?

Return values

stdClass|bool updated user record or false if there is no new info to update.

◆ user_authenticated_hook()

auth_plugin_base::user_authenticated_hook	(	&	$user,
			$username,
			$password )

inherited

Post authentication hook.

This method is called from authenticate_user_login() for all enabled auth plugins.

Parameters

object	$user	user object, later used for $USER
string	$username	(with system magic quotes)
string	$password	plain text password (with system magic quotes)

◆ user_confirm()

auth_plugin_base::user_confirm	(		$username,
			$confirmsecret )

inherited

Confirm the new user as registered.

Parameters

string	$username
string	$confirmsecret

Reimplemented in auth_oauth2\auth, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, and auth_plugin_webservice.

◆ user_delete()

auth_plugin_base::user_delete ( $olduser )

inherited

User delete requested - internal user record is mared as deleted already, username not present anymore.

Do any action in external database.

Parameters

object $user Userobject before delete (without system magic quotes)

Return values

void

◆ user_exists()

auth_plugin_base::user_exists ( $username )

inherited

Checks if user exists in external db.

Parameters

string $username (with system magic quotes)

Return values

bool

Reimplemented in auth_plugin_db, and auth_plugin_ldap.

◆ user_login()

auth_plugin_lti::user_login	(		$username,
			$password )

Users can not log in via the traditional login form.

Parameters

string	$username	The username
string	$password	The password

Return values

bool	Authentication success or failure

Reimplemented from auth_plugin_base.

◆ user_signup()

auth_plugin_base::user_signup	(		$user,
			$notify = true )

inherited

Sign up a new user ready for confirmation.

Password is passed in plaintext.

Parameters

object	$user	new user object
boolean	$notify	print notice with link and terminate

Reimplemented in auth_plugin_email, and auth_plugin_ldap.

◆ user_update()

auth_plugin_base::user_update	(		$olduser,
			$newuser )

inherited

Called when the user record is updated.

Modifies user in external database. It takes olduser (before changes) and newuser (after changes) compares information saved modified information to external db.

Parameters

mixed	$olduser	Userobject before modifications (without system magic quotes)
mixed	$newuser	Userobject new modified userobject (without system magic quotes)

Return values

boolean true if updated or update ignored; false if error

Reimplemented in auth_plugin_db, and auth_plugin_ldap.

◆ user_update_password()

auth_plugin_base::user_update_password	(		$user,
			$newpassword )

inherited

Updates the user's password.

In previous versions of Moodle, the function auth_user_update_password accepted a username as the first parameter. The revised function expects a user object.

Parameters

object	$user	User table object
string	$newpassword	Plaintext password

Return values

bool	True on success

Reimplemented in auth_plugin_db, auth_plugin_email, auth_plugin_ldap, auth_plugin_manual, auth_plugin_nologin, auth_plugin_none, and auth_plugin_webservice.

◆ validate_form()

auth_plugin_base::validate_form	(		$form,
		&	$err )

inherited

A chance to validate form data, and last chance to do stuff before it is inserted in config_plugin.

Parameters

	object	object with submitted configuration settings (without system magic quotes)
array	$err	array of error messages

Deprecated: since Moodle 3.3

Member Data Documentation

◆ PROVISIONING_MODE_AUTO_ONLY

int const auth_plugin_lti::PROVISIONING_MODE_AUTO_ONLY = 1

constant representing the automatic account provisioning mode.

On first launch, for a previously unbound user, this mode dictates that a new Moodle account will be created automatically for the user and bound to their platform credentials {iss, sub}.

◆ PROVISIONING_MODE_PROMPT_EXISTING_ONLY

int const auth_plugin_lti::PROVISIONING_MODE_PROMPT_EXISTING_ONLY = 3

constant representing the prompt for existing only provisioning mode.

On first launch, for a previously unbound user, the mode dictates that the launch user will be presented with a view allowing them to link an existing account only. This is useful for situations like deep linking, where an existing account is needed.

◆ PROVISIONING_MODE_PROMPT_NEW_EXISTING

int const auth_plugin_lti::PROVISIONING_MODE_PROMPT_NEW_EXISTING = 2

constant representing the prompt for new or existing provisioning mode.

On first launch, for a previously unbound user, the mode dictates that the launch user will be presented with an options view, allowing them to select either 'link an existing account' or 'create a new account for me'.

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

auth/lti/auth.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ can_be_manually_set()

◆ can_change_password()

◆ can_confirm()

◆ can_edit_profile()

◆ can_reset_password()

◆ can_signup()

◆ change_password_url()

◆ complete_login()

◆ config_form()

◆ create_new_account()

◆ create_user_binding()

◆ edit_profile_url()

◆ empty_session()

◆ find_cli_admin_user()

◆ find_cli_user()

◆ find_or_create_user_from_launch()

◆ find_or_create_user_from_membership()

◆ get_custom_user_profile_fields()

◆ get_description()

◆ get_enabled_auth_plugin_classes()

◆ get_extrauserinfo()

◆ get_identity_providers()

◆ get_password_change_info()

◆ get_title()

◆ get_user_binding()

◆ get_userinfo()

◆ ignore_timeout_hook()

◆ is_captcha_enabled()

◆ is_configured()

◆ is_internal()

◆ is_synchronised_with_external()

◆ is_valid_provisioning_mode()

◆ login_cli_admin_user()

◆ loginpage_hook()

◆ loginpage_idp_list()

◆ logoutpage_hook()

◆ password_expire()

◆ postlogout_hook()

◆ pre_loginpage_hook()

◆ pre_user_login_hook()

◆ prelogout_hook()

◆ prepare_identity_providers_for_output()

◆ prevent_local_passwords()

◆ process_config()

◆ set_extrauserinfo()

◆ signup_form()

◆ sync_roles()

◆ update_user_account()

◆ update_user_picture()

◆ update_user_record()

◆ user_authenticated_hook()

◆ user_confirm()

◆ user_delete()

◆ user_exists()

◆ user_login()

◆ user_signup()

◆ user_update()

◆ user_update_password()

◆ validate_form()

Member Data Documentation

◆ PROVISIONING_MODE_AUTO_ONLY

◆ PROVISIONING_MODE_PROMPT_EXISTING_ONLY

◆ PROVISIONING_MODE_PROMPT_NEW_EXISTING