API Events HttpRequestSentEvent - evansims/openfga-php GitHub Wiki

Event fired when an HTTP request is sent to the OpenFGA API. This event contains the outgoing request details for telemetry and debugging.

Table of Contents


Namespace

OpenFGA\Events


Source

View source code


Implements


Methods

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|null

Get the model ID for the operation.

View source


Returns

string | null — The model ID or null if not applicable


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

Get the OpenFGA operation name.

View source


Returns

string — The operation name (for example, 'check', 'write', 'read')


getPayload

public function getPayload(): array

Get the event payload data.

View source


Returns

array — The event data


getRequest

public function getRequest(): RequestInterface

Get the HTTP request being sent.

View source


Returns

RequestInterface — The PSR-7 request object


getStoreId

public function getStoreId(): string|null

Get the store ID for the operation.

View source


Returns

string | null — The store ID or null if not applicable


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** ⚠️