\Orpheus\CoreRoute

Official Route for Orpheus

Summary

Methods
Properties
Constants
isAccessible()
getLink()
getName()
suggestResolver()
setResolver()
getRoute()
getCurrentRouteName()
No public properties found
No constants found
No protected methods found
$resolverClass
N/A
No private methods found
No private properties found
N/A

Properties

$resolverClass

$resolverClass : string

Class of the resolver

Type

string

Methods

isAccessible()

isAccessible() : boolean

Test if the route is accessible in the current context using restrictTo This method is sensitive to CHECK_MODULE_ACCESS constant, a true value make it always accessible, never use it in production

Returns

boolean

getLink()

getLink() : boolean

Get the link to this route

Returns

boolean

getName()

getName() : string

Get the name

Returns

string

suggestResolver()

suggestResolver(string  $class) 

Suggest resolve $class

Parameters

string $class

setResolver()

setResolver(string  $class) 

Set the resolver class

Parameters

string $class

getRoute()

getRoute(string  $name) : \Orpheus\Core\Route

Get Route object for this name

Parameters

string $name

Throws

\Exception

Returns

\Orpheus\Core\Route

getCurrentRouteName()

getCurrentRouteName() : \Orpheus\Core\srting

Get the current main route name

Throws

\Exception

Returns

\Orpheus\Core\srting