com.woltlab.wcf.system.auth
All user authentication types should implement the abstract functions of this class.
| Class | Description |
|---|---|
UserAuthDefault |
Default implementation of the user authentication. |
| Return | Name |
|---|---|
static UserAuth |
getInstance()
|
User |
loginAutomatically([boolean $persistent = false], [string $userClassname = 'UserSession'])
|
User |
loginManually(string $username, string $password, [string $userClassname = 'UserSession'])
|
void |
storeAccessData(User $user, string $username, string $password)
|
boolean |
supportsPersistentLogins()
|
public static UserAuth getInstance()
Returns an instance of the enabled user auth class.
public User loginAutomatically([boolean $persistent = false], [string $userClassname = 'UserSession'])
Does an automatic user login.
$persistent - true = persistent login $userClassname - class name of user class Redefined in descendants as: UserAuthDefault::loginAutomatically()
public User loginManually(string $username, string $password, [string $userClassname = 'UserSession'])
Does an manual user login.
$username $password $userClassname - class name of user class Redefined in descendants as: UserAuthDefault::loginManually()
public void storeAccessData(User $user, string $username, string $password)
Stores the user access data for a persistent login.
$user $username $password Redefined in descendants as: UserAuthDefault::storeAccessData()
public boolean supportsPersistentLogins()
Returns true, if this auth type supports persistent logins.
Redefined in descendants as: UserAuthDefault::supportsPersistentLogins()