MapperEvent
extends Event
in package
implements
IWebhookCompatibleEvent
Class MapperEvent
Tags
Table of Contents
Interfaces
- IWebhookCompatibleEvent
- Interface for events which can be listened to by webhooks
Constants
- EVENT_ASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::assignTags'
- EVENT_UNASSIGN = 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags'
Properties
- $event : string
- $objectId : string
- $objectType : string
- $tags : array<string|int, int>
- $propagationStopped : bool
Methods
- __construct() : mixed
- DispatcherEvent constructor.
- getEvent() : string
- getObjectId() : string
- getObjectType() : string
- getTags() : array<string|int, int>
- getWebhookSerializable() : array<string|int, mixed>
- Return data to be serialized and sent to the webhook. Will be serialized using json_encode.
- isPropagationStopped() : bool
- {@inheritDoc}
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Constants
EVENT_ASSIGN
public
mixed
EVENT_ASSIGN
= 'OCP\SystemTag\ISystemTagObjectMapper::assignTags'
Tags
EVENT_UNASSIGN
public
mixed
EVENT_UNASSIGN
= 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags'
Tags
Properties
$event
protected
string
$event
$objectId
protected
string
$objectId
$objectType
protected
string
$objectType
$tags
protected
array<string|int, int>
$tags
$propagationStopped
private
bool
$propagationStopped
= false
Tags
Methods
__construct()
DispatcherEvent constructor.
public
__construct(string $event, string $objectType, string $objectId, array<string|int, int> $tags) : mixed
Parameters
- $event : string
- $objectType : string
- $objectId : string
- $tags : array<string|int, int>
Tags
getEvent()
public
getEvent() : string
Tags
Return values
stringgetObjectId()
public
getObjectId() : string
Tags
Return values
stringgetObjectType()
public
getObjectType() : string
Tags
Return values
stringgetTags()
public
getTags() : array<string|int, int>
Tags
Return values
array<string|int, int>getWebhookSerializable()
Return data to be serialized and sent to the webhook. Will be serialized using json_encode.
public
getWebhookSerializable() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>isPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Return values
boolstopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void