UserEnumerationFilterEvent
extends Event
in package
Base event class for the event dispatcher service
Tags
Attributes
- #[Consumable]
- $since: '31.0.14'
- #[Listenable]
- $since: '31.0.14'
Table of Contents
Properties
- $initialUsers : array<int, string>
- $users : array<string|int, mixed>
Methods
- __construct() : mixed
- Compatibility constructor
- getFilteredOutUsers() : array<int<0, max>, string>
- Get the users what were filtered out by one of the listeners of this event.
- getUsers() : array<int, string>
- isPropagationStopped() : bool
- {@inheritDoc}
- setUsers() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$initialUsers read-only
private
array<int, string>
$initialUsers
$users
private
array<string|int, mixed>
$users
Methods
__construct()
Compatibility constructor
public
__construct(array<int, string> $users) : mixed
Parameters
- $users : array<int, string>
Tags
getFilteredOutUsers()
Get the users what were filtered out by one of the listeners of this event.
public
getFilteredOutUsers() : array<int<0, max>, string>
Tags
Return values
array<int<0, max>, string> —$users
getUsers()
public
getUsers() : array<int, string>
Tags
Return values
array<int, string>isPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Attributes
- #[Override]
Return values
boolsetUsers()
public
setUsers(array<int, string> $users) : void
Parameters
- $users : array<int, string>
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void