interface RoutesInterface

Routes interface

Constants

PAGE

Route type constant

API

HOME_PAGE

ADMIN_API

Methods

array
getHomePageRoute()

Get home page route

array|false
getRoute(string $method, string $pattern)

Get route

array
searchRoutes(string $method, $type = null)

Get routes list for request method

bool
setRedirectUrl(string $method, string $pattern, string $url)

Save route redirect url

bool
setRoutesStatus(array $filter = [], int $status)

Set routes status

bool
addApiRoute(string $method, string $pattern, string $handlerClass, string|null $handlerMethod, string|null $extension, string|null $auth = null, int $type)

Add api route

bool
has(string $method, string $pattern)

Return true if reoute exists

bool
delete(string $method, string $pattern)

Delete route

bool
saveRouteOptions(string $method, string $pattern, array $options)

Save route options

Details

at line 30
array getHomePageRoute()

Get home page route

Return Value

array

at line 39
array|false getRoute(string $method, string $pattern)

Get route

Parameters

string $method
string $pattern

Return Value

array|false

at line 47
array searchRoutes(string $method, $type = null)

Get routes list for request method

Parameters

string $method
$type

Return Value

array

at line 57
bool setRedirectUrl(string $method, string $pattern, string $url)

Save route redirect url

Parameters

string $method
string $pattern
string $url

Return Value

bool

at line 66
bool setRoutesStatus(array $filter = [], int $status)

Set routes status

Parameters

array $filter
int $status

Return Value

bool

at line 81
bool addApiRoute(string $method, string $pattern, string $handlerClass, string|null $handlerMethod, string|null $extension, string|null $auth = null, int $type)

Add api route

Parameters

string $method
string $pattern
string $handlerClass
string|null $handlerMethod
string|null $extension
string|null $auth
int $type

Return Value

bool

Exceptions

Exception

at line 98
bool has(string $method, string $pattern)

Return true if reoute exists

Parameters

string $method
string $pattern

Return Value

bool

at line 107
bool delete(string $method, string $pattern)

Delete route

Parameters

string $method
string $pattern

Return Value

bool

at line 117
bool saveRouteOptions(string $method, string $pattern, array $options)

Save route options

Parameters

string $method
string $pattern
array $options

Return Value

bool