UserEntityInterface
extends
EntityInterface
in
Interface for representing a user account record.
Tags
Table of Contents
- getAuthMethod() : string|null
- Get active authentication method (if any).
- getCatId() : string|null
- Get catalog id.
- getCatPassEnc() : string|null
- Get encrypted catalog password.
- getCatUsername() : string|null
- Get catalog username.
- getCollege() : string
- Get college.
- getCreated() : DateTime
- Created getter
- getEmail() : string
- Get email.
- getEmailVerified() : DateTime|null
- Get email verification date (or null for unverified).
- getFirstname() : string
- Get firstname.
- getHomeLibrary() : string|null
- Get home library.
- getId() : int|null
- Get identifier (returns null for an uninitialized or non-persisted object).
- getLastLanguage() : string
- Get last language.
- getLastLogin() : DateTime
- Last login getter
- getLastname() : string
- Get lastname.
- getMajor() : string
- Get major.
- getPasswordHash() : string|null
- Get hashed password. This should only be used when hashing is enabled.
- getPendingEmail() : string
- Get pending email.
- getRawCatPassword() : string|null
- Get raw catalog password.
- getRawPassword() : string
- Get raw (unhashed) password (if available). This should only be used when hashing is disabled.
- getUsername() : string
- Get username.
- getVerifyHash() : string
- Get verification hash for recovery.
- hasUserProvidedEmail() : bool
- Does the user have a user-provided (true) vs. automatically looked up (false) email address?
- setAuthMethod() : UserEntityInterface
- Set active authentication method (if any).
- setCatId() : UserEntityInterface
- Catalog id setter
- setCatPassEnc() : UserEntityInterface
- Encrypted catalog password setter
- setCatUsername() : UserEntityInterface
- Catalog username setter
- setCollege() : UserEntityInterface
- Set college.
- setCreated() : UserEntityInterface
- Created setter
- setEmail() : UserEntityInterface
- Set email.
- setEmailVerified() : UserEntityInterface
- Set email verification date (or null for unverified).
- setFirstname() : UserEntityInterface
- Set firstname.
- setHasUserProvidedEmail() : UserEntityInterface
- Set the flag indicating whether the email address is user-provided.
- setHomeLibrary() : UserEntityInterface
- Home library setter
- setLastLanguage() : UserEntityInterface
- Set last language.
- setLastLogin() : UserEntityInterface
- Last login setter.
- setLastname() : UserEntityInterface
- Set lastname.
- setMajor() : UserEntityInterface
- Set major.
- setPasswordHash() : UserEntityInterface
- Set hashed password. This should only be used when hashing is enabled.
- setPendingEmail() : UserEntityInterface
- Set pending email.
- setRawCatPassword() : UserEntityInterface
- Raw catalog password setter
- setRawPassword() : UserEntityInterface
- Set raw (unhashed) password (if available). This should only be used when hashing is disabled.
- setUsername() : UserEntityInterface
- Username setter
- setVerifyHash() : UserEntityInterface
- Set verification hash for recovery.
Methods
getAuthMethod()
Get active authentication method (if any).
public
getAuthMethod() : string|null
Return values
string|null —getCatId()
Get catalog id.
public
getCatId() : string|null
Return values
string|null —getCatPassEnc()
Get encrypted catalog password.
public
getCatPassEnc() : string|null
Return values
string|null —getCatUsername()
Get catalog username.
public
getCatUsername() : string|null
Return values
string|null —getCollege()
Get college.
public
getCollege() : string
Return values
string —getCreated()
Created getter
public
getCreated() : DateTime
Return values
DateTime —getEmail()
Get email.
public
getEmail() : string
Return values
string —getEmailVerified()
Get email verification date (or null for unverified).
public
getEmailVerified() : DateTime|null
Return values
DateTime|null —getFirstname()
Get firstname.
public
getFirstname() : string
Return values
string —getHomeLibrary()
Get home library.
public
getHomeLibrary() : string|null
Return values
string|null —getId()
Get identifier (returns null for an uninitialized or non-persisted object).
public
getId() : int|null
Return values
int|null —getLastLanguage()
Get last language.
public
getLastLanguage() : string
Return values
string —getLastLogin()
Last login getter
public
getLastLogin() : DateTime
Return values
DateTime —getLastname()
Get lastname.
public
getLastname() : string
Return values
string —getMajor()
Get major.
public
getMajor() : string
Return values
string —getPasswordHash()
Get hashed password. This should only be used when hashing is enabled.
public
getPasswordHash() : string|null
Return values
string|null —getPendingEmail()
Get pending email.
public
getPendingEmail() : string
Return values
string —getRawCatPassword()
Get raw catalog password.
public
getRawCatPassword() : string|null
Return values
string|null —getRawPassword()
Get raw (unhashed) password (if available). This should only be used when hashing is disabled.
public
getRawPassword() : string
Return values
string —getUsername()
Get username.
public
getUsername() : string
Return values
string —getVerifyHash()
Get verification hash for recovery.
public
getVerifyHash() : string
Return values
string —hasUserProvidedEmail()
Does the user have a user-provided (true) vs. automatically looked up (false) email address?
public
hasUserProvidedEmail() : bool
Return values
bool —setAuthMethod()
Set active authentication method (if any).
public
setAuthMethod(string|null $authMethod) : UserEntityInterface
Parameters
- $authMethod : string|null
-
New value (null for none)
Return values
UserEntityInterface —setCatId()
Catalog id setter
public
setCatId(string|null $catId) : UserEntityInterface
Parameters
- $catId : string|null
-
Catalog id
Return values
UserEntityInterface —setCatPassEnc()
Encrypted catalog password setter
public
setCatPassEnc(string|null $passEnc) : UserEntityInterface
Parameters
- $passEnc : string|null
-
Encrypted password
Return values
UserEntityInterface —setCatUsername()
Catalog username setter
public
setCatUsername(string|null $catUsername) : UserEntityInterface
Parameters
- $catUsername : string|null
-
Catalog username
Return values
UserEntityInterface —setCollege()
Set college.
public
setCollege(string $college) : UserEntityInterface
Parameters
- $college : string
-
College
Return values
UserEntityInterface —setCreated()
Created setter
public
setCreated(DateTime $dateTime) : UserEntityInterface
Parameters
- $dateTime : DateTime
-
Last login date
Return values
UserEntityInterface —setEmail()
Set email.
public
setEmail(string $email) : UserEntityInterface
Parameters
- $email : string
-
Email address
Return values
UserEntityInterface —setEmailVerified()
Set email verification date (or null for unverified).
public
setEmailVerified(DateTime|null $dateTime) : UserEntityInterface
Parameters
- $dateTime : DateTime|null
-
Verification date (or null)
Return values
UserEntityInterface —setFirstname()
Set firstname.
public
setFirstname(string $firstName) : UserEntityInterface
Parameters
- $firstName : string
-
New first name
Return values
UserEntityInterface —setHasUserProvidedEmail()
Set the flag indicating whether the email address is user-provided.
public
setHasUserProvidedEmail(bool $userProvided) : UserEntityInterface
Parameters
- $userProvided : bool
-
New value
Return values
UserEntityInterface —setHomeLibrary()
Home library setter
public
setHomeLibrary(string|null $homeLibrary) : UserEntityInterface
Parameters
- $homeLibrary : string|null
-
Home library
Return values
UserEntityInterface —setLastLanguage()
Set last language.
public
setLastLanguage(string $lang) : UserEntityInterface
Parameters
- $lang : string
-
Last language
Return values
UserEntityInterface —setLastLogin()
Last login setter.
public
setLastLogin(DateTime $dateTime) : UserEntityInterface
Parameters
- $dateTime : DateTime
-
Last login date
Return values
UserEntityInterface —setLastname()
Set lastname.
public
setLastname(string $lastName) : UserEntityInterface
Parameters
- $lastName : string
-
New last name
Return values
UserEntityInterface —setMajor()
Set major.
public
setMajor(string $major) : UserEntityInterface
Parameters
- $major : string
-
Major
Return values
UserEntityInterface —setPasswordHash()
Set hashed password. This should only be used when hashing is enabled.
public
setPasswordHash(string|null $hash) : UserEntityInterface
Parameters
- $hash : string|null
-
Password hash
Return values
UserEntityInterface —setPendingEmail()
Set pending email.
public
setPendingEmail(string $email) : UserEntityInterface
Parameters
- $email : string
-
New pending email
Return values
UserEntityInterface —setRawCatPassword()
Raw catalog password setter
public
setRawCatPassword(string|null $catPassword) : UserEntityInterface
Parameters
- $catPassword : string|null
-
Cat password
Return values
UserEntityInterface —setRawPassword()
Set raw (unhashed) password (if available). This should only be used when hashing is disabled.
public
setRawPassword(string $password) : UserEntityInterface
Parameters
- $password : string
-
Password
Return values
UserEntityInterface —setUsername()
Username setter
public
setUsername(string $username) : UserEntityInterface
Parameters
- $username : string
-
Username
Return values
UserEntityInterface —setVerifyHash()
Set verification hash for recovery.
public
setVerifyHash(string $hash) : UserEntityInterface
Parameters
- $hash : string
-
Hash value to save