Application
in package
Base class of the application
Table of Contents
- $requestParams : HttpRequestParams|null
- Params fetcher
- $router : Router
- Router object
- __call() : mixed
- Allowing to call methods added on the fly
- __construct() : mixed
- Constructor
- buildRoute() : array<string|int, mixed>
- Method builds route data
- getRequestParamsFetcher() : RequestParamsInterface
- Method returns $this->requestParams and creates this object if necessery
- getRouter() : Router
- Method returns router
- handleException() : void
- Method processes exception
- loadRoute() : void
- Method loads single route
- loadRoutes() : void
- Method loads routes
- loadRoutesFromConfig() : void
- Method loads routes from config file in *.php or *.json format
- loadRoutesFromConfigs() : void
- Method loads list of configs
- loadRoutesFromDirectory() : void
- Method loads routes from the directory
- redirectTo() : void
- Method redirects user to another page
- routeExists() : bool
- Method validates that route exists
- run() : void
- Running application
- callRoute() : mixed
- Method calls route and returns it's content
- formatCallStack() : array<string|int, mixed>
- Formatting call stack
Properties
$requestParams
Params fetcher
private
HttpRequestParams|null
$requestParams
= null
$router
Router object
private
Router
$router
Methods
__call()
Allowing to call methods added on the fly
public
__call(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
-
Method to be called
- $args : array<string|int, mixed>
-
Arguments
Return values
mixed —Result of the call
__construct()
Constructor
public
__construct() : mixed
Return values
mixed —buildRoute()
Method builds route data
public
static buildRoute(string $route, string $method, object $handler, string $function) : array<string|int, mixed>
Parameters
- $route : string
-
route
- $method : string
-
HTTP method
- $handler : object
-
object wich handles request
- $function : string
-
controller's function name
Return values
array<string|int, mixed> —built route data
getRequestParamsFetcher()
Method returns $this->requestParams and creates this object if necessery
public
getRequestParamsFetcher() : RequestParamsInterface
Return values
RequestParamsInterface —getRouter()
Method returns router
public
getRouter() : Router
Return values
Router —router
handleException()
Method processes exception
public
handleException(Exception $e) : void
Parameters
- $e : Exception
-
exception object to be formatted
Return values
void —loadRoute()
Method loads single route
public
loadRoute(array<string|int, mixed> $route) : void
Parameters
- $route : array<string|int, mixed>
-
Route settings
Return values
void —loadRoutes()
Method loads routes
public
loadRoutes(array<string|int, mixed> $routes) : void
Parameters
- $routes : array<string|int, mixed>
-
list of routes
Return values
void —loadRoutesFromConfig()
Method loads routes from config file in *.php or *.json format
public
loadRoutesFromConfig(string $configPath) : void
Parameters
- $configPath : string
-
path of the config for routes
Return values
void —loadRoutesFromConfigs()
Method loads list of configs
public
loadRoutesFromConfigs(array<string|int, mixed> $configPaths) : void
Parameters
- $configPaths : array<string|int, mixed>
-
paths to config files
Return values
void —loadRoutesFromDirectory()
Method loads routes from the directory
public
loadRoutesFromDirectory(string $directory) : void
Parameters
- $directory : string
-
path to the directory. Scanninng is recursive.
Return values
void —redirectTo()
Method redirects user to another page
public
redirectTo(string $url) : void
Parameters
- $url : string
-
new page
Return values
void —routeExists()
Method validates that route exists
public
routeExists(string $route) : bool
Parameters
- $route : string
-
route
Return values
bool —true if the route exists
run()
Running application
public
run() : void
Return values
void —callRoute()
Method calls route and returns it's content
protected
callRoute() : mixed
Return values
mixed —route processing result
formatCallStack()
Formatting call stack
protected
formatCallStack(mixed $e) : array<string|int, mixed>
Parameters
- $e : mixed
-
Exception object