authlib.php File Reference

Classes
class	auth_plugin_base
	Abstract authentication plugin. More...

Functions
	display_auth_lock_options ($settings, $auth, $userfields, $helptext, $mapremotefields, $updateremotefields, $customfields=array())
	Helper function used to print locking for auth plugins on admin pages.
	login_attempt_failed ($user)
	To be called after failed user login.
	login_attempt_valid ($user)
	To be called after valid user login.
	login_captcha_enabled ()
	Returns whether the captcha element is enabled for the login form, and the admin settings fulfil its requirements.
	login_is_lockedout ($user)
	Verify if user is locked out.
	login_lock_account ($user)
	Lockout user and send notification email.
	login_unlock_account ($user, bool $notify=false)
	Unlock user account and reset timers.
	signup_captcha_enabled ()
	Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.
	signup_get_user_confirmation_authplugin ()
	Check if user confirmation is enabled on this site and return the auth plugin handling registration if enabled.
	signup_is_enabled ()
	Check if sign-up is enabled in the site.
	signup_setup_new_user ($user)
	Add the missing fields to a user that is going to be created.
	signup_validate_data ($data, $files)
	Validates the standard sign-up data (except recaptcha that is validated by the form element).
	validate_login_captcha (string|bool $captcha)
	Check the submitted captcha is valid or not.

Variables
const	AUTH_CONFIRM_ALREADY 2
const	AUTH_CONFIRM_ERROR 3
const	AUTH_CONFIRM_FAIL 0
	Authentication - error codes for user confirm.
const	AUTH_CONFIRM_OK 1
const	AUTH_DENIED 2
	Returned when the login was denied (a reason for AUTH_FAIL).
const	AUTH_ERROR 4
	Returned when some error occurred (a reason for AUTH_FAIL).
const	AUTH_FAIL 1
	Returned when the login was unsuccessful.
const	AUTH_LOGIN_FAILED 3
	Can not login, most probably password did not match.
const	AUTH_LOGIN_FAILED_RECAPTCHA 6
	Can not login, failed reCaptcha challenge.
const	AUTH_LOGIN_LOCKOUT 4
	Can not login because user is locked out.
const	AUTH_LOGIN_NOUSER 1
	Can not login because user does not exist.
const	AUTH_LOGIN_OK 0
	Login attempt successful.
const	AUTH_LOGIN_SUSPENDED 2
	Can not login because user is suspended.
const	AUTH_LOGIN_UNAUTHORISED 5
	Can not login becauser user is not authorised.
const	AUTH_OK 0
	Returned when the login was successful.
const	AUTH_REMOVEUSER_FULLDELETE 2
const	AUTH_REMOVEUSER_KEEP 0
const	AUTH_REMOVEUSER_SUSPEND 1