\App\Site\RoutingRouteInfo

Route Information Class

Summary

Methods

Properties

Constants

__construct()
getDispatcherInfo()
setDispatcherInfo()
getHandler()
setHandler()
getVars()
getVar()
setVars()
getAllowedMethods()
setAllowedMethods()
getStatus()
setStatus()
getHttpMethod()
setHttpMethod()
getUri()
setUri()
getRoute()
setRoute()
getRouteName()
setRouteName()
getRewrite()
setRewrite()
worksOffline()
isAdminRoute()
toString()
getControllerObject()
setControllerObject()
getData()

No public properties found

No constants found

No protected methods found

$dispatcher_info
$status
$handler
$allowed_methods
$vars
$uri
$http_method
$route
$route_name
$rewrite
$controller_object

N/A

No private methods found

No private properties found

N/A

File: site/routing/RouteInfo.php
Package: Degami\Sitebase
Class hierarchy: \App\Site\Routing\RouteInfo

Properties

$dispatcher_info

$dispatcher_info : array

Type

array — dispatcher info

$status

$status : int

Type

int — dispatcher status

$handler

$handler : mixed

Type

mixed — handler to invoke

$allowed_methods

$allowed_methods : mixed

Type

mixed — allowed methods

$vars

$vars : mixed

Type

mixed — vars

$uri

$uri : string

Type

string — uri

$http_method

$http_method : string

Type

string — http method

$route

$route : string

Type

string — route

$route_name

$route_name : string

Type

string — route name

$rewrite

$rewrite : int|null

Type

int|null — rewrite id

$controller_object

$controller_object : \App\Base\Abstracts\Controllers\BasePage|null

Type

BasePage|null — controller object instance

Methods

__construct()

__construct(array  $dispatcher_info, string  $http_method, string  $uri, string  $route, string|null  $route_name = null, int|null  $rewrite = null) : mixed

class constructor

Parameters

array	$dispatcher_info
string	$http_method
string	$uri
string	$route
string\|null	$route_name
int\|null	$rewrite

Returns

mixed —

getDispatcherInfo()

getDispatcherInfo() : array

gets dispatcher info

Returns

array —

setDispatcherInfo()

setDispatcherInfo(array  $dispatcher_info) : self

sets dispatcher info

Parameters

array

$dispatcher_info

Returns

self —

getHandler()

getHandler() : mixed

gets handler to call

Returns

mixed —

setHandler()

setHandler(callable  $handler) : self

sets handler to call

Parameters

callable

$handler

Returns

self —

getVars()

getVars() : mixed

get router vars

Returns

mixed —

getVar()

getVar(string  $name) : mixed

get router var by name

Parameters

string

$name

Returns

mixed —

setVars()

setVars(mixed  $vars) : self

set router vars

Parameters

mixed

$vars

Returns

self —

getAllowedMethods()

getAllowedMethods() : mixed

get allowed methods

Returns

mixed —

setAllowedMethods()

setAllowedMethods(mixed  $allowed_methods) : self

sets allowed methods

Parameters

mixed

$allowed_methods

Returns

self —

getStatus()

getStatus() : int

gets status

Returns

int —

setStatus()

setStatus(int  $status) : self

sets status

Parameters

int

$status

Returns

self —

getHttpMethod()

getHttpMethod() : string

gets http method

Returns

string —

setHttpMethod()

setHttpMethod(string  $http_method) : self

sets http method

Parameters

string

$http_method

Returns

self —

getUri()

getUri() : string

gets uri

Returns

string —

setUri()

setUri(string  $uri) : self

sets uri

Parameters

string

$uri

Returns

self —

getRoute()

getRoute() : string

gets route

Returns

string —

setRoute()

setRoute(string  $route) : self

sets route

Parameters

string

$route

Returns

self —

getRouteName()

getRouteName() : string

gets route name

Returns

string —

setRouteName()

setRouteName(string  $route_name) : self

sets route name

Parameters

string

$route_name

Returns

self —

getRewrite()

getRewrite() : int|null

gets rewrite

Returns

int|null —

setRewrite()

setRewrite(int  $rewrite) : self

sets rewrite

Parameters

int

$rewrite

Returns

self —

worksOffline()

worksOffline() : bool

checks if route works also if site is offline

Returns

bool —

isAdminRoute()

isAdminRoute() : bool

checks if route is administrative route

Returns

bool —

toString()

toString() : string

{@inheritdocs}

Returns

string —

getControllerObject()

getControllerObject() : \App\Base\Abstracts\Controllers\BasePage|null

gets controller object

Returns

\App\Base\Abstracts\Controllers\BasePage|null —

controller object instance

setControllerObject()

setControllerObject(\App\Base\Abstracts\Controllers\BasePage  $controller_object) : self

sets controller object

Parameters

\App\Base\Abstracts\Controllers\BasePage

$controller_object

Returns

self —

getData()

getData() : array

gets RouteInfo data

Returns

array —