ilAuthDefinition Interface Reference

Description of interface. More...

Inheritance diagram for ilAuthDefinition:

Collaboration diagram for ilAuthDefinition:

Public Member Functions
	getProvider (ilAuthCredentials $credentials, $a_auth_id)
	Get auth provider instance. More...
	getAuthIds ()
	Get authentication id. More...
	getAuthIdByName ($a_auth_name)
	Get the auth id by an auth mode name. More...
	getAuthName ($a_auth_id)
	Get auth name by auth id. More...
	isAuthActive ($a_auth_id)
	Check if auth mode is active. More...
	supportsMultiCheck ($a_auth_id)
	Check whther authentication supports sequenced authentication. More...
	isExternalAccountNameRequired ($a_auth_id)
	Check if an external account name is required for this authentication method Normally this should return true. More...
	isPasswordModificationAllowed ($a_auth_id)
	Check if authentication method allows password modifications. More...
	getLocalPasswordValidationType ($a_auth_id)
	Get local password validation type One of ilAuthUtils::LOCAL_PWV_FULL ilAuthUtils::LOCAL_PWV_NO ilAuthUtils::LOCAL_PWV_USER. More...
	getMultipleAuthModeOptions ($a_auth_id)
	Get an array of options for "multiple auth mode" selection array( AUTH_ID => array( 'txt' => NAME) ) More...

Detailed Description

Description of interface.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 10 of file interface.ilAuthDefinition.php.

Member Function Documentation

getAuthIdByName()

ilAuthDefinition::getAuthIdByName

(

$a_auth_name

)

Get the auth id by an auth mode name.

the auth mode name is stored for each user in table usr_data -> auth_mode

See also

ilAuthUtils::_getAuthMode()

Returns

int

getAuthIds()

ilAuthDefinition::getAuthIds

(

)

Get authentication id.

For plugins the auth must be greater than 1000 and unique

See also

constants like in AUTH_LDAP ilAuthUtils

Returns

int[]

Implemented in ilAuthPlugin.

getAuthName()

ilAuthDefinition::getAuthName

(

$a_auth_id

)

Get auth name by auth id.

Parameters

int

$a_auth_id

Returns

string

Implemented in ilAuthPlugin.

getLocalPasswordValidationType()

ilAuthDefinition::getLocalPasswordValidationType

(

$a_auth_id

)

Get local password validation type One of ilAuthUtils::LOCAL_PWV_FULL ilAuthUtils::LOCAL_PWV_NO ilAuthUtils::LOCAL_PWV_USER.

Returns

int

getMultipleAuthModeOptions()

ilAuthDefinition::getMultipleAuthModeOptions

(

$a_auth_id

)

Get an array of options for "multiple auth mode" selection array( AUTH_ID => array( 'txt' => NAME) )

Parameters

type

$a_auth_id

Returns

array

Implemented in ilAuthPlugin.

getProvider()

ilAuthDefinition::getProvider	(	ilAuthCredentials	$credentials,
			$a_auth_id
	)

Get auth provider instance.

Parameters

	ilAuthCredentials
string	$a_auth_id

Returns

ilAuthProviderInterface

Implemented in ilAuthPlugin.

isAuthActive()

ilAuthDefinition::isAuthActive

(

$a_auth_id

)

Check if auth mode is active.

Returns

bool

Implemented in ilAuthPlugin.

isExternalAccountNameRequired()

ilAuthDefinition::isExternalAccountNameRequired

(

$a_auth_id

)

Check if an external account name is required for this authentication method Normally this should return true.

Returns

bool

Implemented in ilAuthPlugin.

isPasswordModificationAllowed()

ilAuthDefinition::isPasswordModificationAllowed

(

$a_auth_id

)

Check if authentication method allows password modifications.

supportsMultiCheck()

ilAuthDefinition::supportsMultiCheck

(

$a_auth_id

)

Check whther authentication supports sequenced authentication.

See also

ilAuthContainerMultiple

---

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

• Services/Authentication/interfaces/interface.ilAuthDefinition.php