modules/Users/authentication/EmailAuthenticate/EmailAuthenticateUser.php
Show:
inherited
inherited
Classes
\EmailAuthenticateUser
Package:
This file is where the user authentication occurs. No redirection should happen in this file.
- Parent(s)
- \SugarAuthenticateUser
Properties
Methods
authenticateUser(
STRING $name, STRING $password, STRING $fallback
=
false
)
:
STRING
inherited
Does the actual authentication of the user and returns an id that will be used to load the current user (loadUserOnSession)
Inherited from: \SugarAuthenticateUser::authenticateUser()
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
)
:
boolean
inherited
Checks if a user is a sugarLogin user which implies they should use the sugar authentication to login
Inherited from: \SugarAuthenticateUser::isSugarLogin()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | STRING | |
| $password | \STRIUNG |
| Type | Description |
|---|---|
| boolean |
loadUserOnLogin(
STRING $name, STRING $password
)
:
booleanthis is called when a user logs in
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | STRING | |
| $password | STRING |
| Type | Description |
|---|---|
| boolean |
loadUserOnSession(
STRING $user_id
=
''
)
:
boolean
inherited
Loads the current user bassed on the given user_id
Inherited from: \SugarAuthenticateUser::loadUserOnSession()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $user_id | STRING |
| Type | Description |
|---|---|
| boolean |
sendEmailPassword(
\unknown_type $user_id, \unknown_type $password
)
:
voidSends the users password to the email address or sends
Parameters
| Name | Type | Description |
|---|---|---|
| $user_id | \unknown_type | |
| $password | \unknown_type |