Returns the email of the user.
API Tags:
Return: | Email |
Access: | public |
Returns the login name of the user.
API Tags:
Return: | Password Hash |
Access: | public |
Returns the first name of the user.
API Tags:
Return: | First Name |
Access: | public |
Returns the last name of the user.
API Tags:
Return: | Last Name |
Access: | public |
string getNameLastFirst(
)
|
|
Returns a string of the format "Lastname, Firstname".
API Tags:
Return: | String of format "Lastname, Firstname". |
Access: | public |
Returns the hashed password of the user.
API Tags:
Return: | Password Hash |
Access: | public |
Returns the type of the user.
Type may be either 'student' or 'instructor'
API Tags:
Return: | User Type |
Access: | public |
boolean setEmail(
string
$email
)
|
|
Sets the email of the user.
Parameters:
API Tags:
Return: | True on successful set, False otherwise. |
Access: | public |
boolean setLogin(
string
$login
)
|
|
Sets the login name of the user.
Parameters:
string |
$login: |
User Login |
API Tags:
Return: | True on successful set, False otherwise. |
Access: | public |
boolean setNameFirst(
string
$firstname
)
|
|
Sets the first name of the user.
Parameters:
string |
$firstname: |
First Name |
API Tags:
Return: | True on successful set, False otherwise. |
Access: | public |
boolean setNameLast(
string
$lastname
)
|
|
Sets the last name of the user.
Parameters:
string |
$lastname: |
Last Name |
API Tags:
Return: | True on successful set, False otherwise. |
Access: | public |
boolean setPassword(
string
$password
)
|
|
Sets the password of the user.
Pass the password in plaintext, the method will hash it.
Parameters:
string |
$password: |
Plaintext Password |
API Tags:
Return: | True on successful set, False otherwise. |
Access: | public |
boolean setType(
string
$type
)
|
|
Sets the type of the user.
Type must be either 'student' or 'instructor'
Parameters:
API Tags:
Return: | True on successful set, False otherwise. |
Access: | public |
void verify(
string
$userLogin, string
$userPassword
)
|
|
Tests whether the given userlogin and password match those in the datastore.
If a match is found, the user for the given username is loaded into the User object.
Parameters:
string |
$userLogin: |
The user's login name |
string |
$userPassword: |
The password submitted for authentication. |
API Tags: