API Events OperationStartedEvent - evansims/openfga-php GitHub Wiki

Event fired when a high-level operation starts. This event tracks business operations like check, expand, writeTuples, etc.

Table of Contents


Namespace

OpenFGA\Events


Source

View source code


Implements


Methods

getContext

public function getContext(): array<string, mixed>

View source


Returns

array&lt;string, mixed&gt;


getEventId

public function getEventId(): string

Get the unique identifier for this event.

View source


Returns

string — A unique identifier for the event instance


getEventType

public function getEventType(): string

Get the name/type of this event.

View source


Returns

string — The event type identifier


getModelId

public function getModelId(): ?string

View source


Returns

string | null


getOccurredAt

public function getOccurredAt(): DateTimeImmutable

Get when this event occurred.

View source


Returns

DateTimeImmutable — The timestamp when the event was created


getOperation

public function getOperation(): string

View source


Returns

string


getPayload

public function getPayload(): array

Get the event payload data.

View source


Returns

array — The event data


getStoreId

public function getStoreId(): ?string

View source


Returns

string | null


isPropagationStopped

public function isPropagationStopped(): bool

Check if event propagation should be stopped.

View source


Returns

bool — True if propagation should be stopped


stopPropagation

public function stopPropagation(): void

Stop event propagation to remaining listeners.

View source


Returns

void

⚠️ **GitHub.com Fallback** ⚠️