1. class
  2. WPEmerge
  3. \
  4. Routing
  5. \
  6. Router

Router

class Router implements HasRoutesInterface (View source)

Provide routing for site requests (i.e. all non-api requests).

Traits

HasRoutesTrait
Allow objects to have routes

Methods

RouteInterface[]
getRoutes()

Get routes.

from HasRoutesTrait
void
addRoute(RouteInterface $route)

Add a route.

from HasRoutesTrait
void
removeRoute(RouteInterface $route)

Remove a route.

from HasRoutesTrait
__construct(ConditionFactory $condition_factory, HandlerFactory $handler_factory)

Constructor.

RouteInterface
getCurrentRoute()

Get the current route.

void
setCurrentRoute(RouteInterface $current_route)

Set the current route.

string[]
mergeMethodsAttribute(string[] $old, string[] $new)

Merge the methods attribute combining values.

ConditionInterface|string
mergeConditionAttribute(string|array|Closure|ConditionInterface|null $old, string|array|Closure|ConditionInterface|null $new)

Merge the condition attribute.

string[]
mergeMiddlewareAttribute(string[] $old, string[] $new)

Merge the middleware attribute combining values.

string
mergeNamespaceAttribute(string $old, string $new)

Merge the namespace attribute taking the latest value.

string|Closure
mergeHandlerAttribute(string|Closure $old, string|Closure $new)

Merge the handler attribute taking the latest value.

string|Closure
mergeQueryAttribute(callable|null $old, callable|null $new)

Merge the handler attribute taking the latest value.

string
mergeNameAttribute(string $old, string $new)

Merge the name attribute combining values with a dot.

array
mergeAttributes(array $old, array $new)

Merge attributes into route.

void
group(array $attributes, Closure|string $routes)

Create a route group.

RouteInterface
route(array $attributes)

Make a route.

RouteInterface|null
execute(RequestInterface $request)

Assign and return the first satisfied route (if any) as the current one for the given request.

string
getRouteUrl(string $name, array $arguments = [])

Get the url for a named route.

Details

in HasRoutesTrait at line 32
RouteInterface[] getRoutes()

Get routes.

Return Value

RouteInterface[]

in HasRoutesTrait at line 42
void addRoute(RouteInterface $route)

Add a route.

Parameters

RouteInterface $route

Return Value

void

in HasRoutesTrait at line 67
void removeRoute(RouteInterface $route)

Remove a route.

Parameters

RouteInterface $route

Return Value

void

at line 63
__construct(ConditionFactory $condition_factory, HandlerFactory $handler_factory)

Constructor.

Parameters

ConditionFactory $condition_factory
HandlerFactory $handler_factory

at line 73
RouteInterface getCurrentRoute()

Get the current route.

Return Value

RouteInterface

at line 83
void setCurrentRoute(RouteInterface $current_route)

Set the current route.

Parameters

RouteInterface $current_route

Return Value

void

at line 94
string[] mergeMethodsAttribute(string[] $old, string[] $new)

Merge the methods attribute combining values.

Parameters

string[] $old
string[] $new

Return Value

string[]

at line 105
ConditionInterface|string mergeConditionAttribute(string|array|Closure|ConditionInterface|null $old, string|array|Closure|ConditionInterface|null $new)

Merge the condition attribute.

Parameters

string|array|Closure|ConditionInterface|null $old
string|array|Closure|ConditionInterface|null $new

Return Value

ConditionInterface|string

at line 122
string[] mergeMiddlewareAttribute(string[] $old, string[] $new)

Merge the middleware attribute combining values.

Parameters

string[] $old
string[] $new

Return Value

string[]

at line 133
string mergeNamespaceAttribute(string $old, string $new)

Merge the namespace attribute taking the latest value.

Parameters

string $old
string $new

Return Value

string

at line 144
string|Closure mergeHandlerAttribute(string|Closure $old, string|Closure $new)

Merge the handler attribute taking the latest value.

Parameters

string|Closure $old
string|Closure $new

Return Value

string|Closure

at line 155
string|Closure mergeQueryAttribute(callable|null $old, callable|null $new)

Merge the handler attribute taking the latest value.

Parameters

callable|null $old
callable|null $new

Return Value

string|Closure

at line 176
string mergeNameAttribute(string $old, string $new)

Merge the name attribute combining values with a dot.

Parameters

string $old
string $new

Return Value

string

at line 195
array mergeAttributes(array $old, array $new)

Merge attributes into route.

Parameters

array $old mixed> $old
array $new mixed> $new

Return Value

array mixed>

at line 273
void group(array $attributes, Closure|string $routes)

Create a route group.

Parameters

array $attributes mixed> $attributes
Closure|string $routes Closure or path to file.

Return Value

void

at line 327
RouteInterface route(array $attributes)

Make a route.

Parameters

array $attributes mixed> $attributes

Return Value

RouteInterface

at line 353
RouteInterface|null execute(RequestInterface $request)

Assign and return the first satisfied route (if any) as the current one for the given request.

Parameters

RequestInterface $request

Return Value

RouteInterface|null

at line 373
string getRouteUrl(string $name, array $arguments = [])

Get the url for a named route.

Parameters

string $name
array $arguments

Return Value

string