modules/Users/authentication/SugarAuthenticate/SugarAuthenticateUser.php
Show:
inherited
inherited
Classes
\SugarAuthenticateUser
Package: SugarCRM
This file is where the user authentication occurs. No redirection should happen in this file.
Methods
authenticateUser(
STRING $name, STRING $password, STRING $fallback
=
false
)
:
STRINGDoes the actual authentication of the user and returns an id that will be used to load the current user (loadUserOnSession)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | STRING | |
| $password | STRING | |
| $fallback | STRING |
|
| Type | Description |
|---|---|
| STRING | id - used for loading the user |
isSugarLogin(
STRING $name, \STRIUNG $password
)
:
booleanChecks if a user is a sugarLogin user which implies they should use the sugar authentication to login
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | STRING | |
| $password | \STRIUNG |
| Type | Description |
|---|---|
| boolean |
loadUserOnLogin(
STRING $name, STRING $password, STRING $fallback
=
false, $PARAMS
=
array()
)
:
booleanthis is called when a user logs in
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | STRING | |
| $password | STRING | |
| $fallback | STRING |
|
| $PARAMS |
| Type | Description |
|---|---|
| boolean |
loadUserOnSession(
STRING $user_id
=
''
)
:
booleanLoads the current user bassed on the given user_id
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $user_id | STRING |
| Type | Description |
|---|---|
| boolean |