UserEvent

API reference › yii › web › UserEvent

class	`yii\web\UserEvent`
Extends	`yii\base\Event` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/web/UserEvent.php`

This event class is used for Events triggered by the User class.

Properties

Property	Type	Description	Defined by
`$cookieBased`	`bool`	Whether the login is cookie-based. Default: `null`.	`UserEvent`
`$data`	`mixed`	The data that is passed to `Component::on()` when attaching an event handler. Default: `null`.	`yii\base\Event`
`$duration`	`int`	Number of seconds that the user can remain in logged-in status. Default: `null`.	`UserEvent`
`$handled`	`bool`	Whether the event is handled. Default: `false`.	`yii\base\Event`
`$identity`	`IdentityInterface`	The identity object associated with this event Default: `null`.	`UserEvent`
`$isValid`	`bool`	Whether the login or logout should proceed. Default: `true`.	`UserEvent`
`$name`	`string`	The event name. Default: `null`.	`yii\base\Event`
`$sender`	`object\|null`	The sender of this event. Default: `null`.	`yii\base\Event`

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`hasHandlers()` static	Returns a value indicating whether there is any handler attached to the specified class-level event.	`yii\base\Event`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`off()` static	Detaches an event handler from a class-level event.	`yii\base\Event`
`offAll()` static	Detaches all registered class-level event handlers.	`yii\base\Event`
`on()` static	Attaches an event handler to a class-level event.	`yii\base\Event`
`trigger()` static	Triggers a class-level event.	`yii\base\Event`

public bool $cookieBased = null

Whether the login is cookie-based.

public int $duration = null

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 bool $isValid = true

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.