Route
in package
Uses
HttpMethod
Table of Contents
- $storedPrefixedGroups : array<string|int, mixed>
- $collector : RouteCollector|null
- The active FastRoute collector.
- $groupStateStack : array<string|int, mixed>
- Stack to manage middleware inheritance of nested groups.
- $prefixStack : array<string|int, mixed>
- Stack to manage group prefixes.
- 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
- performStoredGroupsMatchingPrefix() : void
- Performs middleware matching for stored groups based on the current URL parts.
- post() : PendingRoute
- put() : PendingRoute
- buildEndpoint() : string
- callControllerAction() : mixed
- getCurrentRouter() : RouteCollector
- Gets the current route collector.
- getInheritedAfterMiddlewares() : array<string|int, mixed>
- getInheritedMiddlewares() : array<string|int, mixed>
- performCallableAction() : void
- Keeps callback compatibility with route closures using 0..3 parameters.
- resolveMethod() : string|array<string|int, mixed>
Properties
$storedPrefixedGroups
public
static array<string|int, mixed>
$storedPrefixedGroups
= []
$collector
The active FastRoute collector.
private
static RouteCollector|null
$collector
= null
$groupStateStack
Stack to manage middleware inheritance of nested groups.
private
static array<string|int, mixed>
$groupStateStack
= []
array<int, array{middleware: array, afterMiddleware: array}>
$prefixStack
Stack to manage group prefixes.
private
static array<string|int, mixed>
$prefixStack
= []
Methods
any()
public
static any(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —define()
public
static define(string $method, string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $method : string
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —delete()
public
static delete(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —get()
public
static get(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —group()
public
static group([string $prefix = "" ][, callable|null $callback = null ]) : PendingGroup
Parameters
- $prefix : string = ""
- $callback : callable|null = null
Return values
PendingGroup —init()
Initializes the static Router.
public
static init(ZubZet $booter, RouteCollector $collector) : void
This must be called once before loading route files.
Parameters
- $booter : ZubZet
- $collector : RouteCollector
Return values
void —options()
public
static options(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —patch()
public
static patch(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : 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, PendingAction $action, array<string|int, mixed> $middlewares, array<string|int, mixed> $afterMiddleware) : void
Parameters
- $method : string
- $endpoint : string
- $action : PendingAction
- $middlewares : array<string|int, mixed>
- $afterMiddleware : array<string|int, mixed>
Return values
void —performStoredGroupsMatchingPrefix()
Performs middleware matching for stored groups based on the current URL parts.
public
static performStoredGroupsMatchingPrefix(array<string|int, mixed> $urlParts, Closure|callable $callback) : void
Parameters
- $urlParts : array<string|int, mixed>
- $callback : Closure|callable
Return values
void —post()
public
static post(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —put()
public
static put(string $endpoint, array<string|int, mixed>|callable $action[, array<string|int, mixed> $arguments = [] ]) : PendingRoute
Parameters
- $endpoint : string
- $action : array<string|int, mixed>|callable
- $arguments : array<string|int, mixed> = []
Return values
PendingRoute —buildEndpoint()
private
static buildEndpoint(string $endpoint) : string
Parameters
- $endpoint : string
Return values
string —callControllerAction()
private
static callControllerAction(string $class, string $method[, array<string|int, mixed> $args = [] ][, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
- $class : string
- $method : string
- $args : array<string|int, mixed> = []
- $arguments : array<string|int, mixed> = []
Return values
mixed —getCurrentRouter()
Gets the current route collector.
private
static getCurrentRouter() : RouteCollector
Return values
RouteCollector —getInheritedAfterMiddlewares()
private
static getInheritedAfterMiddlewares() : array<string|int, mixed>
Return values
array<string|int, mixed> —getInheritedMiddlewares()
private
static getInheritedMiddlewares() : array<string|int, mixed>
Return values
array<string|int, mixed> —performCallableAction()
Keeps callback compatibility with route closures using 0..3 parameters.
private
static performCallableAction(callable $action, array<string|int, mixed> $args) : void
Parameters
- $action : callable
- $args : array<string|int, mixed>
Return values
void —resolveMethod()
private
static resolveMethod(string $method) : string|array<string|int, mixed>
Parameters
- $method : string