Docs For Class auth

Inherited Properties	Inherited Methods
Inherited From auth_interface auth_interface::$m_fatalError	Inherited From auth_interface auth_interface::allowed() Check if the currently logged-in user has a certain privilege on a node. auth_interface::attribAllowed() Check if the currently logged-in user has the right to view, edit etc. auth_interface::canMd5() Does the authentication method support md5 encoding of passwords? auth_interface::getAttribEntity() This function returns the level/group(s) that are allowed to view/edit a certain attribute of a given node. auth_interface::getEntity() This function returns the level/group(s) that are allowed to perform the given action on a node. auth_interface::getPassword() This function returns password or false, if password can't be retrieve/recreate auth_interface::getPasswordPolicy() This function returns "get password" policy for current auth method auth_interface::getUser() This function returns information about a user in an associative array with the following elements: "name" -> the userid (should normally be the same as the $user variable that gets passed to it. auth_interface::getUserList() This function returns the list of users that may login. This can be used to display a dropdown of users from which to choose. auth_interface::logout() Logout handling. The default implementation does simple session destruction and recreates a new session. auth_interface::validateUser() Authenticate a user.

Inherited Properties

Inherited Methods

Inherited From auth_interface

auth_interface::$m_fatalError

Inherited From auth_interface

auth_interface::allowed()

Check if the currently logged-in user has a certain privilege on a node.

auth_interface::attribAllowed()

Check if the currently logged-in user has the right to view, edit etc.

auth_interface::canMd5()

Does the authentication method support md5 encoding of passwords?

auth_interface::getAttribEntity()

This function returns the level/group(s) that are allowed to view/edit a certain attribute of a given node.

auth_interface::getEntity()

This function returns the level/group(s) that are allowed to perform the given action on a node.

auth_interface::getPassword()

This function returns password or false, if password can't be retrieve/recreate

auth_interface::getPasswordPolicy()

This function returns "get password" policy for current auth method

auth_interface::getUser()

This function returns information about a user in an associative array with the following elements: "name" -> the userid (should normally be the same as the $user variable that gets passed to it.

auth_interface::getUserList()

This function returns the list of users that may login. This can be used to display a dropdown of users from which to choose.

auth_interface::logout()

Logout handling. The default implementation does simple session destruction and recreates a new session.

auth_interface::validateUser()

Authenticate a user.

[ Top ]

Method Summary

boolean	canMd5()	Does this authentication method support md5 encoding of passwords? Imap authentication cannot support md5 encoding of passwords
int	validateUser()	Authenticate a user.

[ Top ]

Properties

Methods

canMd5 [line 85]

boolean canMd5(
)

Does this authentication method support md5 encoding of passwords? Imap authentication cannot support md5 encoding of passwords

API Tags:

Return:

false

Redefinition of:

auth_interface::canMd5(): Does the authentication method support md5 encoding of passwords?

[ Top ]

validateUser [line 49]

int validateUser(
String
$user, String
$passwd 
)

Authenticate a user.

Parameters:

String	$user:	The login of the user to authenticate.
String	$passwd:	The password of the user. Note: if the canMd5 function of an implementation returns true, $passwd will be passed as an md5 string.

API Tags:

Return:

AUTH_SUCCESS - Authentication succesful AUTH_MISMATCH - Authentication failed, wrong user/password combination AUTH_LOCKED - Account is locked, can not login with current username. AUTH_ERROR - Authentication failed due to some error which cannot be solved by just trying again. If you return this value, you *must* also fill the m_fatalError variable.

Redefinition of:

auth_interface::validateUser(): Authenticate a user.

[ Top ]