1. class
  2. mako
  3. \
  4. http
  5. \
  6. routing
  7. \
  8. Dispatcher

Dispatcher

class Dispatcher

Route dispatcher.

Traits

FunctionParserTrait
Function parser trait.

Constants

MIDDLEWARE_DEFAULT_PRIORITY

Default middleware priority.

Properties

protected Request $request Request.
protected Response $response Response.
protected Container $container Container.
protected array $middleware Route middleware.
protected array $globalMiddleware Global middleware.
protected array $middlewarePriority Middleware priority.

Methods

array
splitFunctionAndParameters(string $function)

Splits function name and parameters into an array.

from FunctionParserTrait
array
parseFunction(string $function, bool|null $namedParameters = null)

Parses custom "function calls".

from FunctionParserTrait
__construct(Request $request, Response $response, Container|null $container = null)

Constructor.

Dispatcher
setMiddlewarePriority(array $priority)

Sets the middleware priority.

Dispatcher
resetMiddlewarePriority()

Resets middleware priority.

Dispatcher
registerMiddleware(string $name, string $middleware, int|null $priority = null)

Registers middleware.

Dispatcher
setMiddlewareAsGlobal(array $middleware)

Sets the chosen middleware as global.

array
resolveMiddleware(string $middleware)

Resolves the middleware.

array
orderMiddlewareByPriority(array $middleware)

Orders resolved middleware by priority.

addMiddlewareToStack(Onion $onion, array $middleware)

Adds route middleware to the stack.

Response
executeClosure(Closure $closure, array $parameters)

Executes a closure action.

Response
executeController(string $controller, array $parameters)

Executes a controller action.

Response
executeAction(Route $route)

Executes the route action.

Response
dispatch(Route $route)

Dispatches the route and returns the response.

Details

in FunctionParserTrait at line 32
protected array splitFunctionAndParameters(string $function)

Splits function name and parameters into an array.

Parameters

string $function Function

Return Value

array

Exceptions

RuntimeException

in FunctionParserTrait at line 52
protected array parseFunction(string $function, bool|null $namedParameters = null)

Parses custom "function calls".

The return value is an array consisting of the function name and parameters.

Parameters

string $function Function
bool|null $namedParameters Are we expecting named parameters?

Return Value

array

Exceptions

RuntimeException

at line 95
__construct(Request $request, Response $response, Container|null $container = null)

Constructor.

Parameters

Request $request Request instance
Response $response Response instance
Container|null $container Container

at line 110
Dispatcher setMiddlewarePriority(array $priority)

Sets the middleware priority.

Parameters

array $priority Middleware priority

Return Value

Dispatcher

at line 122
Dispatcher resetMiddlewarePriority()

Resets middleware priority.

Return Value

Dispatcher

at line 137
Dispatcher registerMiddleware(string $name, string $middleware, int|null $priority = null)

Registers middleware.

Parameters

string $name Middleware name
string $middleware Middleware class name
int|null $priority Middleware priority

Return Value

Dispatcher

at line 155
Dispatcher setMiddlewareAsGlobal(array $middleware)

Sets the chosen middleware as global.

Parameters

array $middleware Array of middleware names

Return Value

Dispatcher

at line 169
protected array resolveMiddleware(string $middleware)

Resolves the middleware.

Parameters

string $middleware middleware

Return Value

array

Exceptions

RuntimeException

at line 187
protected array orderMiddlewareByPriority(array $middleware)

Orders resolved middleware by priority.

Parameters

array $middleware Array of middleware

Return Value

array

at line 226
protected addMiddlewareToStack(Onion $onion, array $middleware)

Adds route middleware to the stack.

Parameters

Onion $onion Middleware stack
array $middleware Array of middleware

at line 260
protected Response executeClosure(Closure $closure, array $parameters)

Executes a closure action.

Parameters

Closure $closure Closure
array $parameters Parameters

Return Value

Response

at line 272
protected Response executeController(string $controller, array $parameters)

Executes a controller action.

Parameters

string $controller Controller
array $parameters Parameters

Return Value

Response

at line 322
protected Response executeAction(Route $route)

Executes the route action.

Parameters

Route $route Route

Return Value

Response

at line 342
Response dispatch(Route $route)

Dispatches the route and returns the response.

Parameters

Route $route Route

Return Value

Response