Class dektrium\user\models\SettingsForm

All Classes | Properties | Methods

Inheritance	dektrium\user\models\SettingsForm » yii\base\Model

SettingsForm gets user's username, email and password and changes them.

Public Properties

Hide inherited properties

Property	Type	Defined By
$current_password	string	dektrium\user\models\SettingsForm
$email	string	dektrium\user\models\SettingsForm
$new_password	string	dektrium\user\models\SettingsForm
$username	string	dektrium\user\models\SettingsForm

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$mailer	dektrium\user\Mailer		dektrium\user\models\SettingsForm
$module	dektrium\user\Module		dektrium\user\models\SettingsForm

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		dektrium\user\models\SettingsForm
attributeLabels()		dektrium\user\models\SettingsForm
formName()		dektrium\user\models\SettingsForm
getUser()		dektrium\user\models\SettingsForm
rules()		dektrium\user\models\SettingsForm
save()	Saves new account settings.	dektrium\user\models\SettingsForm

Protected Methods

Hide inherited methods

Method	Description	Defined By
defaultEmailChange()	Sends a confirmation message to user's email address with link to confirm changing of email.	dektrium\user\models\SettingsForm
insecureEmailChange()	Changes user's email address to given without any confirmation.	dektrium\user\models\SettingsForm
secureEmailChange()	Sends a confirmation message to both old and new email addresses with link to confirm changing of email.	dektrium\user\models\SettingsForm

Property Details

$current_password public property

public string $current_password = null

$email public property

public string $email = null

$mailer protected property

protected dektrium\user\Mailer $mailer = null

$module protected property

protected dektrium\user\Module $module = null

$new_password public property

public string $new_password = null

$username public property

public string $username = null

Method Details

__construct() public method

public void __construct ( dektrium\user\Mailer $mailer, $config = [] )
$mailer
$config

attributeLabels() public method

public void attributeLabels ( )

defaultEmailChange() protected method

Sends a confirmation message to user's email address with link to confirm changing of email.

protected void defaultEmailChange ( )

formName() public method

public void formName ( )

getUser() public method

public dektrium\user\models\User getUser ( )

insecureEmailChange() protected method

Changes user's email address to given without any confirmation.

protected void insecureEmailChange ( )

rules() public method

public void rules ( )

save() public method

Saves new account settings.

public bool save ( )

secureEmailChange() protected method

Sends a confirmation message to both old and new email addresses with link to confirm changing of email.

protected void secureEmailChange ( )
throws	\yii\base\InvalidConfigException