Question

In yii I can use:

self::ERROR_USERNAME_INVALID;

I want another one:

self::ERROR_USER_BANNED;

That must give the error:

Sorry, but you cannot login because you account has been blocked.

How do I set this up?

Answer 1

Add it directly to your protected/components/UserIdentity.php :

class UserIdentity extends CUserIdentity {
    const ERROR_USER_BANNED = -1; // say -1 you have to give some int value

    public function authenticate() {
        // ... code ...
        if (/* condition to check for banning */) { // you might want to put this check right after any other username checks, and before password checks
            $this->errorCode=self::ERROR_USER_BANNED;
            $this->errorMessage='Sorry, but you cannot login because your account has been blocked.'
            return $this->errorCode;
        }
    }
}

The default way with LoginForm.php model :

Add a new validator rule, say to your username field:

public function rules() {
    return array(
        // ... other rules ...
        array('username','isBanned')
    );
}

// the isbanned validator
public function isBanned($attribute,$params) {
    if($this->_identity===null)
        $this->_identity=new UserIdentity($this->username,$this->password);

    if($this->_identity->authenticate() === UserIdentity::ERROR_USER_BANNED){
        $this->addError($attribute,$this->_identity->errorMessage);
}

Ofcourse you could have declared another function in UserIdentity to check just for banning, and call that function from the isBanned validator, instead of having things in the authenticate function.