Class dektrium\user\controllers\SettingsController

Inheritancedektrium\user\controllers\SettingsController » yii\web\Controller
Uses Traitsdektrium\user\traits\AjaxValidationTrait, dektrium\user\traits\EventTrait

SettingsController manages updating user settings (e.g. profile, email and password).

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$defaultAction dektrium\user\controllers\SettingsController

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() dektrium\user\controllers\SettingsController
actionAccount() Displays page where user can update account settings (username, email or password). dektrium\user\controllers\SettingsController
actionConfirm() Attempts changing user's email address. dektrium\user\controllers\SettingsController
actionDelete() Completely deletes user's account. dektrium\user\controllers\SettingsController
actionDisconnect() Disconnects a network account from user. dektrium\user\controllers\SettingsController
actionNetworks() Displays list of connected network accounts. dektrium\user\controllers\SettingsController
actionProfile() Shows profile settings form. dektrium\user\controllers\SettingsController
behaviors() dektrium\user\controllers\SettingsController

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
EVENT_AFTER_ACCOUNT_UPDATE 'afterAccountUpdate' Event is triggered after updating user's account settings. Triggered with \dektrium\user\events\FormEvent. dektrium\user\controllers\SettingsController
EVENT_AFTER_CONFIRM 'afterConfirm' Event is triggered after changing users' email address. Triggered with \dektrium\user\events\UserEvent. dektrium\user\controllers\SettingsController
EVENT_AFTER_DELETE 'afterDelete' Event is triggered after deleting user's account. Triggered with \dektrium\user\events\UserEvent. dektrium\user\controllers\SettingsController
EVENT_AFTER_DISCONNECT 'afterDisconnect' Event is triggered after disconnecting social account from user. Triggered with \dektrium\user\events\ConnectEvent. dektrium\user\controllers\SettingsController
EVENT_AFTER_PROFILE_UPDATE 'afterProfileUpdate' Event is triggered after updating user's profile. Triggered with \dektrium\user\events\UserEvent. dektrium\user\controllers\SettingsController
EVENT_BEFORE_ACCOUNT_UPDATE 'beforeAccountUpdate' Event is triggered before updating user's account settings. Triggered with \dektrium\user\events\FormEvent. dektrium\user\controllers\SettingsController
EVENT_BEFORE_CONFIRM 'beforeConfirm' Event is triggered before changing users' email address. Triggered with \dektrium\user\events\UserEvent. dektrium\user\controllers\SettingsController
EVENT_BEFORE_DELETE 'beforeDelete' Event is triggered before deleting user's account. Triggered with \dektrium\user\events\UserEvent. dektrium\user\controllers\SettingsController
EVENT_BEFORE_DISCONNECT 'beforeDisconnect' Event is triggered before disconnecting social account from user. Triggered with \dektrium\user\events\ConnectEvent. dektrium\user\controllers\SettingsController
EVENT_BEFORE_PROFILE_UPDATE 'beforeProfileUpdate' Event is triggered before updating user's profile. Triggered with \dektrium\user\events\UserEvent. dektrium\user\controllers\SettingsController

Property Details

$defaultAction public property
public $defaultAction 'profile'
$finder protected property
protected dektrium\user\Finder $finder null

Method Details

__construct() public method

public void __construct ( $id, $module, dektrium\user\Finder $finder, $config = [] )
$id string
$module \yii\base\Module
$finder dektrium\user\Finder
$config array
actionAccount() public method

Displays page where user can update account settings (username, email or password).

public string|\yii\web\Response actionAccount ( )
actionConfirm() public method

Attempts changing user's email address.

public string actionConfirm ( $id, $code )
$id int
$code string
throws \yii\web\HttpException
actionDelete() public method

Completely deletes user's account.

public \yii\web\Response actionDelete ( )
throws Exception
actionDisconnect() public method

Disconnects a network account from user.

public \yii\web\Response actionDisconnect ( $id )
$id int
throws \yii\web\NotFoundHttpException
throws \yii\web\ForbiddenHttpException
actionNetworks() public method

Displays list of connected network accounts.

public string actionNetworks ( )
actionProfile() public method

Shows profile settings form.

public string|\yii\web\Response actionProfile ( )
behaviors() public method

public void behaviors ( )