Stud.IP: StudipAuthSSO Class Reference

Inheritance diagram for StudipAuthSSO:

Public Member Functions
	getUser ()

	isAuthenticated ($username, $password)

	isUsedUsername ($username)

	logout ()

Public Member Functions inherited from StudipAuthAbstract
	__construct ($config=[])

	authenticateUser ($username, $password)

	getStudipUser ($username)

	doNewUserInit ($user)

	setUserDomains ($user)

	getUserDomains ()

	doDataMapping ($user)

	isMappedField ($name)

	verifyUsername ($username)

	isUsedUsername ($username)

	isAuthenticated ($username, $password)

	__isset ($offset)

	__set ($offset, $value)

	__get ($offset)

	__unset ($offset)

	getKeptVariables ()

	getKeptVariable (string $key)

Data Fields
	$plugin_fullname

	$login_description

Data Fields inherited from StudipAuthAbstract
	$error_msg

	$is_new_user = false

array	$user_domains = null

bool	$sync_all_domains = true

	$user_data_mapping = null

	$plugin_name

	$error_head

	$show_login

Additional Inherited Members
Static Public Member Functions inherited from StudipAuthAbstract
static	getInstance ($plugin_name=false)

static	isSSOEnabled ()

static	isLoginEnabled ()

static	CheckAuthentication ($username, $password)

static	CheckUsername ($username)

static	CheckField ($field_name, $plugin_name)

static	CheckIPRange ()

static	CheckIPRangeV4 ($ip, $range)

static	CheckIPRangeV6 ($ip, $range)

Member Function Documentation

getUser ( )

abstract

Return the current username.

Check whether this user can be authenticated. The default implementation just checks whether $username is not empty.

isUsedUsername ( $username )

SSO auth plugins cannot determine if a username is used.

logout ( )

Use this to log out the user

$login_description

$plugin_fullname

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