Route

Properties

router

public Router $router

callable

private mixed $callable

path

public string $path

responseType

private ResponseType $responseType = 'ResponseType'

methods

private array $methods

actionArgs

private array $actionArgs

callableParameters

private array $callableParameters

middleware

private array $middleware

Methods

__construct

public __construct(?string $path, array $methods): void

Parameters

Parameter	Type	Description
$path	string
$methods	array

setCallable

Sets the callable for the route and processes its reflection.

public setCallable(mixed $callable): void

Parameters

Parameter	Type	Description
$callable	mixed	The callable to be set. It can be a closure, an array with a class and method, or a reflection method.

setActionArgs

Sets the arguments for the route action.

public setActionArgs(array $actionArgs): void

Parameters

Parameter	Type	Description
$actionArgs	array	an array of default arguments to be passed to the route action

setRouter

Sets the router instance for the application.

public setRouter(Router $router): void

Parameters

Parameter	Type	Description
$router	Router	the router instance to be set

getPath

Retrieves the path associated with the current route.

public getPath(): ?string

Matches the given HTTP method and path against the route's method and path.

public (string $method, string $path): bool

Parameters

Parameter	Type	Description
$method	string	The HTTP method to match (e.g., 'GET', 'POST').
$path	string	the request path to match

getControllerClass

public getControllerClass(): ?string

getControllerName

public getControllerName(): string

getController

Retrieves the controller instance based on the callable property.

public getController(Request $request): ?Controller

This method checks if the callable property is a Closure or an array. If it is a Closure, it returns a new Closure instance. If it is an array, it extracts the controller class name, verifies its existence, and returns a new instance of the controller class.

Parameters

Parameter	Type	Description
$request	Request

getAction

Retrieves the action to be executed.

public getAction(): string

This method checks if the action is defined in the callable array. If it is, it returns that action. Otherwise, it falls back to the default action specified in the router configuration.

getActionArgs

Retrieve the action arguments.

public getActionArgs(): void

This method returns an array of arguments that are passed to the action.

getResponseType

Retrieves the response type of the route.

public getResponseType(): ResponseType

getMiddleware

Get the names of all middleware associated with the route.

public getMiddleware(): void

prefixPath

Prefixes the path of the route with the given path.

public prefixPath(string $path): void

Parameters

Parameter	Type	Description
$path	string	the path to be prefixed

middleware

Adds middleware(s) to the route.

public middleware(string $middleware, mixed $args): self

Accepts a string of middleware names separated by colons and merges them into the existing middleware array.

Parameters

Parameter	Type	Description
$middleware	string	the middleware to add, either as a string or an instance
$args	mixed

getMiddlewareHandlers

Retrieves the list of middleware associated with the route.

public getMiddlewareHandlers(): void

auth

Adds authentication middleware to the route.

public auth(?Adapter $adapter, mixed $args): self

This method initializes the authentication middleware stack using session, cookie, and JWT mechanisms, and attaches it to the route. Optionally, a custom authentication adapter and additional arguments can be provided.

Parameters

Parameter	Type	Description
$adapter	Adapter	optional authentication adapter to use
$args	mixed

session

Initializes session handling middleware for the route.

public session(mixed $args): self

This method will add session middleware to the route, allowing a session to be created but without requiring authentication. Any additional arguments can be passed to customize the session handling behavior.

Parameters

Parameter	Type	Description
$args	mixed

ratelimit

Adds a rate limiting middleware to the route.

public ratelimit(int $requests, int $seconds): self

Limits the number of requests that can be made to this route within a specified time window. This is a helper that will use the defaults for the selected RateLimiter backend, which is cache-based by default. For more advanced usage, you can directly add a Ratelimiter middleware with custom options using the middleware() method.

Parameters

Parameter	Type	Description
$requests	int	the maximum number of allowed requests within the time window
$seconds	int	the time window in seconds for the rate limit

---

Generated by Hazaar API Doc Generator on Sun, 01 Mar 2026 09:22:26 +0000