# UserEvent

> This event class is used for Events triggered by the yii\web\User class.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [web](/docs/api/yii/web/index.md) › UserEvent

| class | `yii\web\UserEvent` |
| --- | --- |
| Extends | [`yii\base\Event`](/docs/api/yii/base/event/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/web/UserEvent.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/web/UserEvent.php#L19) |

This event class is used for Events triggered by the [`User`](/docs/api/yii/web/user/index.md) class.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| [`$cookieBased`](#property-cookieBased) | `bool` | Whether the login is cookie-based. Default: `null`. | `UserEvent` |
| <span id="property-data"></span>[`$data`](/docs/api/yii/base/event/index.md#property-data) | `mixed` | The data that is passed to [`Component::on()`](/docs/api/yii/base/component/index.md#method-on) when attaching an event handler. Default: `null`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| [`$duration`](#property-duration) | `int` | Number of seconds that the user can remain in logged-in status. Default: `null`. | `UserEvent` |
| <span id="property-handled"></span>[`$handled`](/docs/api/yii/base/event/index.md#property-handled) | `bool` | Whether the event is handled. Default: `false`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="property-identity"></span>`$identity` | [`IdentityInterface`](/docs/api/yii/web/identityinterface/index.md) | The identity object associated with this event Default: `null`. | `UserEvent` |
| [`$isValid`](#property-isValid) | `bool` | Whether the login or logout should proceed. Default: `true`. | `UserEvent` |
| <span id="property-name"></span>[`$name`](/docs/api/yii/base/event/index.md#property-name) | `string` | The event name. Default: `null`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |
| <span id="property-sender"></span>[`$sender`](/docs/api/yii/base/event/index.md#property-sender) | `object\|null` | The sender of this event. Default: `null`. | [`yii\base\Event`](/docs/api/yii/base/event/index.md) |

## Methods

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

## Property details

### $cookieBased <span id="property-cookieBased"></span>

```php
public bool $cookieBased = null
```

Whether the login is cookie-based.

This property is only meaningful
for [`User::EVENT_BEFORE_LOGIN`](/docs/api/yii/web/user/index.md#const-EVENT_BEFORE_LOGIN) and [`User::EVENT_AFTER_LOGIN`](/docs/api/yii/web/user/index.md#const-EVENT_AFTER_LOGIN) events.

### $duration <span id="property-duration"></span>

```php
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.

### $isValid <span id="property-isValid"></span>

```php
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`](/docs/api/yii/web/user/index.md#const-EVENT_BEFORE_LOGIN) and [`User::EVENT_BEFORE_LOGOUT`](/docs/api/yii/web/user/index.md#const-EVENT_BEFORE_LOGOUT) events.