Class yii\web\UserEvent
| Inheritance | yii\web\UserEvent » yii\base\Event » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/web/UserEvent.php |
This event class is used for Events triggered by the yii\web\User class.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $cookieBased | boolean | Whether the login is cookie-based. | yii\web\UserEvent |
| $data | mixed | The data that is passed to yii\base\Component::on() when attaching an event handler. | yii\base\Event |
| $duration | integer | Number of seconds that the user can remain in logged-in status. | yii\web\UserEvent |
| $handled | boolean | Whether the event is handled. | yii\base\Event |
| $identity | yii\web\IdentityInterface | The identity object associated with this event | yii\web\UserEvent |
| $isValid | boolean | Whether the login or logout should proceed. | yii\web\UserEvent |
| $name | string | The event name. | yii\base\Event |
| $sender | object | The sender of this event. | yii\base\Event |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Object |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of an object property. | yii\base\Object |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
| __set() | Sets value of an object property. | yii\base\Object |
| __unset() | Sets an object property to null. | yii\base\Object |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| hasHandlers() | 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\Object |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
| init() | Initializes the object. | yii\base\Object |
| off() | Detaches an event handler from a class-level event. | yii\base\Event |
| offAll() | Detaches all registered class-level event handlers. | yii\base\Event |
| on() | Attaches an event handler to a class-level event. | yii\base\Event |
| trigger() | Triggers a class-level event. | yii\base\Event |
Property Details
Whether the login is cookie-based. This property is only meaningful for yii\web\User::EVENT_BEFORE_LOGIN and yii\web\User::EVENT_AFTER_LOGIN events.
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.
The identity object associated with this event
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 yii\web\User::EVENT_BEFORE_LOGIN and yii\web\User::EVENT_BEFORE_LOGOUT events.