extends |
BaseEvent |
|---|---|
implements |
StoppableEventInterface |
uses |
StoppableEventTrait |
An event requesting content negotiation of a route.
The route can be obtained using the getRoute() method. This is typically used to store the alias for a named route under the FatFree Framework, although it can be used to store the route pattern as well.
The request body to be processed can be obtained from the getRequest() method.
If the listener is able to process the request, it should call the stopPropagation()
method to stop further processing.
| Methods | ||
|---|---|---|
public
|
__construct(string $route, array<string, mixed> $request, string|null $accept)
|
# |
public
|
getRoute(): string
|
# |
public
|
getRequest(): array<string, mixed>
|
# |
public
|
getAcceptHeader(): string
|
# |
public
|
negotiate(array<string>|string $listener_types): string|false
|
# |
| Methods used from SimpleID\Util\Events\StoppableEventTrait |
|---|
isPropagationStopped(), stopPropagation() |
| Properties | |||
|---|---|---|---|
protected
|
string
|
$route
|
# |
protected
|
array<string, mixed>
|
$request
|
# |
protected
|
string|null
|
$acceptHeader
|
# |
| Properties used from SimpleID\Util\Events\StoppableEventTrait |
|---|
$stopped |