PHP Class yii\web\UserEvent

Since: 2.0
Author: Qiang Xue ([email protected])
Inheritance: extends yii\base\Event
Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property Type Description
$cookieBased whether the login is cookie-based. This property is only meaningful for [[User::EVENT_BEFORE_LOGIN]] and [[User::EVENT_AFTER_LOGIN]] events.
$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.
$identity the identity object associated with this event
$isValid whether the login or logout should proceed. Event handlers may modify this property to determine whether the login or logout should proceed. This property is only meaningful for [[User::EVENT_BEFORE_LOGIN]] and [[User::EVENT_BEFORE_LOGOUT]] events.

Property Details

$cookieBased public property

whether the login is cookie-based. This property is only meaningful for [[User::EVENT_BEFORE_LOGIN]] and [[User::EVENT_AFTER_LOGIN]] events.
public $cookieBased

$duration public property

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.
public int $duration
return integer

$identity public property

the identity object associated with this event
public $identity

$isValid public property

whether the login or logout should proceed. Event handlers may modify this property to determine whether the login or logout should proceed. This property is only meaningful for [[User::EVENT_BEFORE_LOGIN]] and [[User::EVENT_BEFORE_LOGOUT]] events.
public $isValid