UserLiveStatusEvent
extends Event
in package
Base event class for the event dispatcher service
Tags
Table of Contents
Constants
- STATUS_AWAY = 'away'
- STATUS_OFFLINE = 'offline'
- STATUS_ONLINE = 'online'
Properties
- $propagationStopped : bool
- $status : string
- $timestamp : int
- $user : IUser
- $userStatus : IUserStatus|null
Methods
- __construct() : mixed
- Compatibility constructor
- getStatus() : string
- getTimestamp() : int
- getUser() : IUser
- getUserStatus() : IUserStatus|null
- Get the user status that might be available after processing the event
- isPropagationStopped() : bool
- {@inheritDoc}
- setUserStatus() : mixed
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Constants
STATUS_AWAY
public
string
STATUS_AWAY
= 'away'
Tags
STATUS_OFFLINE
public
string
STATUS_OFFLINE
= 'offline'
Tags
STATUS_ONLINE
public
string
STATUS_ONLINE
= 'online'
Tags
Properties
$propagationStopped
private
bool
$propagationStopped
= false
Tags
$status
private
string
$status
$timestamp
private
int
$timestamp
$user
private
IUser
$user
$userStatus
private
IUserStatus|null
$userStatus
= null
Methods
__construct()
Compatibility constructor
public
__construct(IUser $user, string $status, int $timestamp) : mixed
Parameters
- $user : IUser
- $status : string
- $timestamp : int
Tags
getStatus()
public
getStatus() : string
Tags
Return values
stringgetTimestamp()
public
getTimestamp() : int
Tags
Return values
intgetUser()
public
getUser() : IUser
Tags
Return values
IUsergetUserStatus()
Get the user status that might be available after processing the event
public
getUserStatus() : IUserStatus|null
Tags
Return values
IUserStatus|nullisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolsetUserStatus()
public
setUserStatus(IUserStatus $userStatus) : mixed
Parameters
- $userStatus : IUserStatus
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void