Orpheus

CliRoute extends ControllerRoute

in package

• orpheus

Route for Orpheus.

Table of Contents

Constants

PROVIDERS_KEY  = 'providers'

REQUIREMENTS_KEY  = 'require-packages'

Properties

$controller  : AbstractController

The running controller

$controllerClass  : string

The class of called controller associated to this route

$defaultResponse  : string

Default response if controller returns is invalid

$initialized  : bool

Define this class initialized

$name  : string

A route is identified by its name

$options  : array<string|int, mixed>

Non-processed options in route configuration

$path  : string

The path determine how to access this route

$restrictTo  : array<string|int, mixed>

Restrictions to access this route

$routes  : array<string|int, mixed>

Registered routes

$routesRestrictions  : array<string|int, mixed>

Registered route restrictions

Methods

__toString()  : string

Get route as string

formatUrl()  : string

Format the current route to get a URL from path

getController()  : AbstractController

getControllerClass()  : string

Get the controller class

getCurrentRouteName()  : string

Get the current route name

getLink()  : string

Get the link to this route

getName()  : string

Get the name

getOptions()  : array<string|int, mixed>

Get route options

getPath()  : string

Get the path

getRootCommand()  : string

getRoute()  : CliRoute

Get the route object for the $route name

getRoutes()  : array<string|int, ControllerRoute>

Get registered routes

initialize()  : void

Initialize the route class by loading the configuration (once only)

instantiateController()  : AbstractController

Instantiate the controller and return it

isAccessible()  : bool

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

isInitialized()  : bool

Test if the class is initialized

isMatchingRequest()  : bool

Test current route is matching request

register()  : void

Register route by $name

registerAccessRestriction()  : void

Register the access restriction $type This will be used by isAccessible()

registerConfig()  : void

Register route by $name from config

run()  : OutputResponse

Run the $request by processing the matching controller

__construct()  : mixed

Constructor

loadRoutes()  : void

Load routes from $package or app (if null)

mergeRoutes()  : void

Merge routes array with routes' logic

populateRoutesFromFile()  : void

Populate given array with routes from $file in $package (or app if null)