Class yii\web\UserEvent

继承yii\web\UserEvent » yii\base\Event » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/web/UserEvent.php

此事件类用于由 yii\web\User 类触发的事件.

公共属性

隐藏继承的属性

属性类型描述定义在
$cookieBased boolean 登录是否是基于 cookie 的. yii\web\UserEvent
$data mixed 附加事件处理程序时传递给 yii\base\Component::on() 的数据. yii\base\Event
$duration integer 用户可以保持登录状态的秒数. yii\web\UserEvent
$handled boolean 事件是否被处理. yii\base\Event
$identity yii\web\IdentityInterface 与此事件关联的身份对象. yii\web\UserEvent
$isValid boolean 是否应该继续登录或注销. yii\web\UserEvent
$name string 事件的名称. yii\base\Event
$sender object 此事件的发送者. yii\base\Event

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__construct() 构造函数. yii\base\BaseObject
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
hasHandlers() 返回一个值, 指示是否有附加到指定类级别事件的处理程序. yii\base\Event
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\base\BaseObject
off() 从类级别的事件中分离事件处理程序. yii\base\Event
offAll() 分离所有已注册的类级别事件处理程序. yii\base\Event
on() 将事件处理程序附加到类级别的事件. yii\base\Event
trigger() 触发类级别的事件. yii\base\Event

属性详情

$cookieBased public 属性

登录是否是基于 cookie 的.

该属性仅对 yii\web\User::EVENT_BEFORE_LOGINyii\web\User::EVENT_AFTER_LOGIN 事件有意义.

public boolean $cookieBased null
$duration public 属性

用户可以保持登录状态的秒数.

如果为0, 则表示登录直到用户关闭浏览器或会话(session)被手动销毁.

public integer $duration null
$identity public 属性

与此事件关联的身份对象.

$isValid public 属性

是否应该继续登录或注销.

事件处理程序可能会修改此属性以确定是否应继续登录或注销.

该属性仅对 yii\web\User::EVENT_BEFORE_LOGINyii\web\User::EVENT_BEFORE_LOGOUT 事件有意义.

public boolean $isValid true