Router

Properties

defaultConfig

Default configuration.

public array $defaultConfig = array (
  'controller' => 'index',
  'action' => 'index',
  'args' => 
  array (
  ),
)

internal

Internal controllers.

public array $internal = array (
  'hazaar' => '\\Hazaar\\Controller\\Internal',
)

config

public array $config

instance

public self $instance

routeLoader

private Loader $routeLoader

routes

private array $routes

Methods

__construct

public __construct(array $config): void

Parameters

Parameter	Type	Description
$config	array

initialise

public initialise(): bool

evaluateRequest

Evaluates the given request and matches it against the defined routes.

public evaluateRequest(Request $request): ?Route

Parameters

Parameter	Type	Description
$request	Request	the request to evaluate

addRoute

Adds a route to the router.

public addRoute(Route $route): void

This method sets the router for the given route and then adds the route to the list of routes managed by this router.

Parameters

Parameter	Type	Description
$route	Route	the route to be added

getErrorController

Retrieves the error controller instance.

public getErrorController(): Error

This method checks the configuration for a specified error controller class. If the class exists and is a subclass of the Error class, it instantiates and returns the error controller. If no valid error controller is found in the configuration, it returns a default Error instance.

get

Registers a route that responds to HTTP GET requests.

public get(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the URL path for the route
$callable	mixed	the callback or controller action to handle the request

post

Registers a route that responds to HTTP POST requests.

public post(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the URL path for the route
$callable	mixed	the callback or controller method to handle the request

put

Registers a route that responds to HTTP PUT requests.

public put(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the URI path that the route will respond to
$callable	mixed	the handler for the route, which can be a callable or other valid route handler

delete

Registers a route that responds to HTTP DELETE requests.

public delete(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the URL path that the route should match
$callable	mixed	the callback or controller action to be executed when the route is matched

patch

Registers a route that responds to HTTP PATCH requests.

public patch(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the URI path that the route will match
$callable	mixed	the callback or controller action to be executed when the route is matched

options

Registers a route that responds to HTTP OPTIONS requests.

public options(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the URL path to match
$callable	mixed	the callback or controller action to handle the request

any

Registers a route that responds to any HTTP method.

public any(string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$path	string	the path pattern to match
$callable	mixed	the callback to execute when the route is matched

Matches a route with the given HTTP methods, path, and callable.

public (string $methods, string $path, mixed $callable): void

Parameters

Parameter	Type	Description
$methods	string	The HTTP methods to match (e.g., ['GET', 'POST']).
$path	string	The path to match (e.g., '/user/{id}').
$callable	mixed	The callable to execute when the route is matched. It can be a string in the format 'Class::method', an array with the class and method, or a Closure.

add

public add(Route $route): void

Parameters

Parameter	Type	Description
$route	Route

---

Generated by Hazaar API Doc Generator