Class humhub\modules\user\controllers\AuthController
Inheritance | humhub\modules\user\controllers\AuthController » humhub\components\Controller » yii\web\Controller |
---|---|
Available since version | 0.5 |
AuthController handles login and logout
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$actionTitlesMap | array | Page titles | humhub\components\Controller |
$layout | humhub\modules\user\controllers\AuthController | ||
$pageTitle | string | Title of the rendered page | humhub\components\Controller |
$prependActionTitles | boolean | Append page title | humhub\components\Controller |
$subLayout | null|string | The name of the sub layout to be applied to this controller's views. | humhub\components\Controller |
Protected Properties
Property | Type | Description | Defined By |
---|---|---|---|
$access | string | Defines the ControllerAccess class for this controller responsible for managing access rules | humhub\components\Controller |
Public Methods
Protected Methods
Method | Description | Defined By |
---|---|---|
forbidden() | humhub\components\Controller | |
getAccessRules() | Returns access rules for the standard access control behavior. | humhub\components\Controller |
login() | Login user | humhub\modules\user\controllers\AuthController |
Events
Event | Type | Description | Defined By |
---|---|---|---|
EVENT_AFTER_LOGIN | \humhub\modules\user\controllers\Triggered | After an successful login. | humhub\modules\user\controllers\AuthController |
EVENT_INIT | \yii\base\Event | An event raised on init a controller. | humhub\components\Controller |
Property Details
Method Details
Allows third party applications to convert a valid sessionId into a username.
public void actionGetSessionUserJson ( ) |
Displays the login page
public void actionLogin ( ) |
Logouts a User
public void actionLogout ( ) |
public void actions ( ) |
public void beforeAction ( $action ) | ||
$action |
Login user
protected \humhub\modules\user\controllers\Response login ( $user, $authClient ) | ||
$user | humhub\modules\user\models\User | |
$authClient | \yii\authclient\BaseClient | |
return | \humhub\modules\user\controllers\Response | The current response object |
---|
Handle successful authentication
public \humhub\modules\user\controllers\Response onAuthSuccess ( \yii\authclient\BaseClient $authClient ) | ||
$authClient | \yii\authclient\BaseClient | |
throws | Throwable |
---|