class User extends ActiveRecord implements IdentityInterface
{
use ModuleTrait;
const USER_CREATE_INIT = 'user_create_init';
const USER_CREATE_DONE = 'user_create_done';
const USER_REGISTER_INIT = 'user_register_init';
const USER_REGISTER_DONE = 'user_register_done';
/** @var string Plain password. Used for model validation. */
public $password;
/**
* @return bool Whether the user is confirmed or not.
*/
public function getIsConfirmed()
{
return $this->confirmed_at != null;
}
/**
* @return bool Whether the user is blocked or not.
*/
public function getIsBlocked()
{
return $this->blocked_at != null;
}
/**
* @return bool Whether the user is an admin or not.
*/
public function getIsAdmin()
{
return in_array($this->username, $this->module->admins);
}
/**
* @return \yii\db\ActiveQuery
*/
public function getProfile()
{
return $this->hasOne($this->module->manager->profileClass, ['user_id' => 'id']);
}
/**
* @return Account[] Connected accounts ($provider => $account)
*/
public function getAccounts()
{
$connected = [];
$accounts = $this->hasMany($this->module->manager->accountClass, ['user_id' => 'id'])->all();
/** @var Account $account */
foreach ($accounts as $account) {
$connected[$account->provider] = $account;
}
return $connected;
}
/** @inheritdoc */
public function getId()
{
return $this->getAttribute('id');
}
/** @inheritdoc */
public function getAuthKey()
{
return $this->getAttribute('auth_key');
}
/** @inheritdoc */
public function attributeLabels()
{
return [
'username' => \Yii::t('user', 'Username'),
'email' => \Yii::t('user', 'Email'),
//'registration_ip' => \Yii::t('user', 'Registration ip'),
'unconfirmed_email' => \Yii::t('user', 'New email'),
'password' => \Yii::t('user', 'Password'),
'created_at' => \Yii::t('user', 'Registration time'),
'confirmed_at' => \Yii::t('user', 'Confirmation time'),
];
}
/** @inheritdoc */
public function behaviors()
{
return [
TimestampBehavior::className(),
];
}
/** @inheritdoc */
public function scenarios()
{
return [
'register' => ['username', 'email', 'password', 'role_id', 'name', 'surname'],
'connect' => ['username', 'email'],
'create' => ['username', 'email', 'password', 'role', 'role_id', 'name', 'surname'],
'update' => ['username', 'email', 'password', 'role', 'role_id', 'name', 'surname'],
'settings' => ['username', 'email', 'password']
];
}
/** @inheritdoc */
public function rules()
{
return [
// username rules
['username', 'required', 'on' => ['register', 'connect', 'create', 'update']],
['username', 'match', 'pattern' => '/^[a-zA-Z]\w+$/'],
['username', 'string', 'min' => 3, 'max' => 25],
['username', 'unique'],
['username', 'trim'],
// name rules
['name', 'required', 'on' => ['register', 'create', 'update']],
['name', 'string', 'min' => 1, 'max' => 24],
['name', 'trim'],
// surname rules
['surname', 'safe', 'on' => ['register', 'create', 'update']],
['surname', 'string', 'min' => 1, 'max' => 30],
['surname', 'trim'],
// role_id rules
['role_id', 'required', 'on' => ['register', 'create', 'update']],
// email rules
['email', 'required', 'on' => ['register', 'connect', 'create', 'update', 'update_email']],
['email', 'email'],
['email', 'string', 'max' => 255],
['email', 'unique'],
['email', 'trim'],
// unconfirmed email rules
['unconfirmed_email', 'required', 'on' => 'update_email'],
['unconfirmed_email', 'unique', 'targetAttribute' => 'email', 'on' => 'update_email'],
['unconfirmed_email', 'email', 'on' => 'update_email'],
// password rules
['password', 'required', 'on' => ['register', 'update_password']],
['password', 'string', 'min' => 6, 'on' => ['register', 'update_password', 'create']],
// current password rules
['current_password', 'required', 'on' => ['update_email', 'update_password']],
['current_password', function ($attr) {
if (!empty($this->$attr) && !Password::validate($this->$attr, $this->password_hash)) {
$this->addError($attr, \Yii::t('user', 'Current password is not valid'));
}
}, 'on' => ['update_email', 'update_password']],
];
}
/** @inheritdoc */
public function validateAuthKey($authKey)
{
return $this->getAttribute('auth_key') == $authKey;
}
/**
* This method is used to create new user account. If password is not set, this method will generate new 8-char
* password. After saving user to database, this method uses mailer component to send credentials
* (username and password) to user via email.
*
* @return bool
*/
public function create()
{
if ($this->getIsNewRecord() == false) {
throw new \RuntimeException('Calling "' . __CLASS__ . '::' . __METHOD__ . '" on existing user');
}
$this->confirmed_at = time();
if ($this->password == null) {
$this->password = Password::generate(8);
}
$this->trigger(self::USER_CREATE_INIT);
if ($this->save()) {
$this->trigger(self::USER_CREATE_DONE);
$this->module->mailer->sendWelcomeMessage($this);
\Yii::getLogger()->log('User has been created', Logger::LEVEL_INFO);
return true;
}
\Yii::getLogger()->log('An error occurred while creating user account', Logger::LEVEL_ERROR);
return false;
}
/**
* This method is used to register new user account. If Module::enableConfirmation is set true, this method
* will generate new confirmation token and use mailer to send it to the user. Otherwise it will log the user in.
* If Module::enableGeneratingPassword is set true, this method will generate new 8-char password. After saving user
* to database, this method uses mailer component to send credentials (username and password) to user via email.
*
* @return bool
*/public function afterSave($insert, $changedAttributes)
{
if ($insert) {
$profile = $this->module->manager->createProfile([
'user_id' => $this->id,
'gravatar_email' => $this->email
]);
$profile->save(false);
}
parent::afterSave($insert, $changedAttributes);
}