yii\web\User::beforeLogin PHP Method

beforeLogin() protected method

The default implementation will trigger the [[EVENT_BEFORE_LOGIN]] event. If you override this method, make sure you call the parent implementation so that the event is triggered.
protected beforeLogin ( yii\web\IdentityInterface $identity, boolean $cookieBased, integer $duration ) : boolean
$identity yii\web\IdentityInterface the user identity information
$cookieBased boolean whether the login is cookie-based
$duration integer number of seconds that the user can remain in logged-in status. If 0, it means login till the user closes the browser or the session is manually destroyed.
return boolean whether the user should continue to be logged in
    protected function beforeLogin($identity, $cookieBased, $duration)
    {
        $event = new UserEvent(['identity' => $identity, 'cookieBased' => $cookieBased, 'duration' => $duration]);
        $this->trigger(self::EVENT_BEFORE_LOGIN, $event);
        return $event->isValid;
    }

Usage Example

Example #1
0
 /**
  * Before user sign in. Returns true if user can sign in.
  *
  * @param IdentityInterface $identity the user identity information
  * @param boolean $cookieBased whether the login is cookie-based
  * @param integer $duration number of seconds that the user can remain in logged-in status.
  * If 0, it means login till the user closes the browser or the session is manually destroyed.
  * @return boolean whether the user should continue to be logged in
  */
 public function beforeLogin($identity, $cookieBased, $duration)
 {
     /* @var $identity User */
     if ($identity instanceof User && !$identity->canSignIn()) {
         return false;
     }
     return parent::beforeLogin($identity, $cookieBased, $duration);
 }
All Usage Examples Of yii\web\User::beforeLogin