PreTopicCreateEvent
extends AbstractEvent
in package
Represents a class-based event.
Table of Contents
Properties
- $alert_url : string
- $content : string
- $mention_notification_title : LanguageKey
- $mention_notification_type : string
- $user : User
Methods
- __construct() : mixed
- description() : string
- Get the description of the event.
- internal() : bool
- Determine whether to hide this hook from users in the StaffCP, some events should be private.
- name() : string
- Convert the class name to the event name.
- params() : array<string|int, mixed>
- Get the parameters of the event.
Properties
$alert_url
public
string
$alert_url
$content
public
string
$content
$mention_notification_title
public
LanguageKey
$mention_notification_title
$mention_notification_type
public
string
$mention_notification_type
$user
public
User
$user
Methods
__construct()
public
__construct(string $content, User $user, string $alert_url, string $mention_notification_type, LanguageKey $mention_notification_title) : mixed
Parameters
- $content : string
- $user : User
- $alert_url : string
- $mention_notification_type : string
- $mention_notification_title : LanguageKey
description()
Get the description of the event.
public
static description() : string
Return values
string —The description of the event
internal()
Determine whether to hide this hook from users in the StaffCP, some events should be private.
public
static internal() : bool
Return values
bool —Whether to hide this hook from users in the StaffCP
name()
Convert the class name to the event name.
public
static name() : string
Example: UserDeletedEvent -> userDeleted.
Return values
string —The name of the subclass, without the "Event" suffix
params()
Get the parameters of the event.
public
final params() : array<string|int, mixed>
Parameters are assumed to be public properties of the event class.
Return values
array<string|int, mixed> —The parameters of the event