Route
in package
Table of Contents
- $booter : z_framework|null
- The framework bootstrapper instance.
- $isCancelled : mixed
- $prefixStack : array<string|int, mixed>
- Stack to manage group prefixes.
- $routerStack : array<string|int, mixed>
- A stack to hold the current router context (App or RouteCollectorProxy).
- any() : PendingRoute
- define() : PendingRoute
- delete() : PendingRoute
- get() : PendingRoute
- group() : PendingGroup
- init() : void
- Initializes the static Router.
- options() : PendingRoute
- patch() : PendingRoute
- performGroup() : void
- Creates a route group.
- performRoute() : void
- post() : PendingRoute
- put() : PendingRoute
- getCurrentRouter() : App|RouteCollectorProxy
- Gets the current router from the top of the stack.
- performRouteInclusions() : void
Properties
$booter
The framework bootstrapper instance.
private
static z_framework|null
$booter
= null
$isCancelled
private
static mixed
$isCancelled
= false
$prefixStack
Stack to manage group prefixes.
private
static array<string|int, mixed>
$prefixStack
= []
$routerStack
A stack to hold the current router context (App or RouteCollectorProxy).
private
static array<string|int, mixed>
$routerStack
= []
Methods
any()
public
static any(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —define()
public
static define(string $method, string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $method : string
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —delete()
public
static delete(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —get()
public
static get(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —group()
public
static group(string $prefix, callable $callback) : PendingGroup
Parameters
- $prefix : string
- $callback : callable
Return values
PendingGroup —init()
Initializes the static Router.
public
static init(App $app, mixed $booter) : void
This must be called once before loading route files.
Parameters
- $app : App
-
The main Slim App instance.
- $booter : mixed
-
The main framework class for callbacks.
Return values
void —options()
public
static options(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —patch()
public
static patch(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —performGroup()
Creates a route group.
public
static performGroup(string $prefix, callable $callback, array<string|int, mixed> $middlewares, array<string|int, mixed> $afterMiddleware) : void
Parameters
- $prefix : string
- $callback : callable
- $middlewares : array<string|int, mixed>
- $afterMiddleware : array<string|int, mixed>
Return values
void —performRoute()
public
static performRoute(string $method, string $endpoint, array<string|int, mixed> $action, array<string|int, mixed> $middlewares, array<string|int, mixed> $afterMiddleware) : void
Parameters
- $method : string
- $endpoint : string
- $action : array<string|int, mixed>
- $middlewares : array<string|int, mixed>
- $afterMiddleware : array<string|int, mixed>
Return values
void —post()
public
static post(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —put()
public
static put(string $endpoint, array<string|int, mixed> $action) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>
Return values
PendingRoute —getCurrentRouter()
Gets the current router from the top of the stack.
private
static getCurrentRouter() : App|RouteCollectorProxy
Return values
App|RouteCollectorProxy —performRouteInclusions()
private
static performRouteInclusions(array<string|int, mixed> $middlewares, array<string|int, mixed> $afterMiddlewares, RouteInterface|RouteGroupInterface $routable) : void
Parameters
- $middlewares : array<string|int, mixed>
- $afterMiddlewares : array<string|int, mixed>
- $routable : RouteInterface|RouteGroupInterface