ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions
ilAuthDefinition Interface Reference

Description of interface. More...

+ Collaboration diagram for ilAuthDefinition:

Public Member Functions

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

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

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

See Also
ilAuthUtils::_getAuthMode()
Returns
int
ilAuthDefinition::getAuthIds ( )

Get an authentication id.

For plugins the auth must be greater than 1000 and unique

See Also
constants in ilAuthUtils
Returns
array
ilAuthDefinition::getAuthName (   $a_auth_id)

Get auth name by auth id.

Parameters
type$a_auth_id
Returns
string
ilAuthDefinition::getContainer (   $a_auth_id)

Get auth container instance.

Returns
Auth_Container
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
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
ilAuthDefinition::isAuthActive (   $a_auth_id)

Check if auth mode is active.

Returns
bool
ilAuthDefinition::isExternalAccountNameRequired (   $a_auth_id)

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

Returns
bool
ilAuthDefinition::isPasswordModificationAllowed (   $a_auth_id)

Check if authentication method allows password modifications.

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: