\Orpheus\InputController\CLIControllerCLIRoute

The CLIRoute class

Summary

Methods

Properties

Constants

isMatchingRequest()
getRoutes()
registerConfig()
run()
processUserException()
processException()
initialize()
isInitialized()
getName()
getPath()
getControllerClass()
instanciateController()
getOptions()
isAccessible()
getLink()
formatURL()
registerAccessRestriction()
getCurrentRouteName()
suggestResolver()
setResolver()
getRoute()
prepare()
getRootCommand()
getUsageCommand()
__toString()
register()
getParameters()

No public properties found

No constants found

__construct()

$name
$path
$controllerClass
$options
$restrictTo
$defaultResponse
$routes
$routesRestrictions
$initialized
$resolverClass
$parameters

N/A

No private methods found

No private properties found

N/A

File: orpheus-inputcontroller\src\InputController\CLIController\CLIRoute.php
Package: Default
Class hierarchy: \Orpheus\Core\Route

\Orpheus\InputController\ControllerRoute

\Orpheus\InputController\CLIController\CLIRoute

Properties

$name

$name : string

A route is identified by its name

Type

string — The name

$path

$path : string

The path determine how to access this route

Type

string — The path

$controllerClass

$controllerClass : string

The class of called controller associated to this route

Type

string — The controller class

$options

$options : array

Non-processed options in route configuration

Type

array

$restrictTo

$restrictTo : array

Restrictions to access this route

Type

array

$defaultResponse

$defaultResponse : \Orpheus\InputController\OutputResponse

Default response if controller returns is invalid

Type

\Orpheus\InputController\OutputResponse

$routes

$routes : array

Registered routes

Type

array

$routesRestrictions

$routesRestrictions : array

Registered route restrictions

Type

array

$initialized

$initialized : string

Define this class initialized

Type

string

$resolverClass

$resolverClass : string

Class of the resolver

Type

string

$parameters

$parameters : array<mixed,string>

Available parameters

Type

array<mixed,string>

Methods

isMatchingRequest()

isMatchingRequest(\Orpheus\InputController\CLIController\CLIRequest  $request, array  $values = array(), boolean  $alternative = false)

Test current route is matching request

Parameters

\Orpheus\InputController\CLIController\CLIRequest	$request
array	$values
boolean	$alternative	True if we are looking for an alternative route, because we did not find any primary one

getRoutes()

getRoutes() : array

Get registered routes

Returns

array

registerConfig()

registerConfig(string  $name, array  $config)

Register route by $name from config

Parameters

string	$name
array	$config

Throws

\Exception

run()

run(\Orpheus\InputController\InputRequest  $request) : \Orpheus\InputController\OutputResponse

Run the $request by processing the matching controller

Parameters

\Orpheus\InputController\InputRequest

$request

Throws

\Orpheus\Exception\NotFoundException
\Orpheus\Exception\ForbiddenException

Returns

\Orpheus\InputController\OutputResponse

processUserException()

processUserException(\Orpheus\Exception\UserException  $exception, array  $values = array()) : \Orpheus\InputController\OutputResponse

Process the given $exception with the default response

Parameters

\Orpheus\Exception\UserException	$exception
array	$values

Returns

\Orpheus\InputController\OutputResponse

processException()

processException(\Orpheus\Exception\UserException  $exception) : \Orpheus\InputController\OutputResponse

Process the given $exception with the default response

Parameters

\Orpheus\Exception\UserException

$exception

Returns

\Orpheus\InputController\OutputResponse

initialize()

initialize()

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

isInitialized()

isInitialized() : boolean

Test if the class is initialized

Returns

boolean

getName()

getName() : string

Get the name

Returns

string

getPath()

getPath() : string

Get the path

Returns

string

getControllerClass()

getControllerClass() : string

Get the controller class

Returns

string

instanciateController()

instanciateController() : \Orpheus\InputController\Controller

Instanciate the controller and return it

Returns

\Orpheus\InputController\Controller

getOptions()

getOptions() : array

Get route options

Returns

array

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

formatURL()

formatURL(array<mixed,string>  $values = array()) : string

Format the current route to get an URL from path

Parameters

array<mixed,string>

$values

Throws

\Orpheus\InputController\CLIController\Exception

Returns

string

registerAccessRestriction()

registerAccessRestriction(string  $type, callable  $callable)

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

Parameters

string	$type
callable	$callable

getCurrentRouteName()

getCurrentRouteName() : \Orpheus\Core\srting

Get the current main route name

Throws

\Exception

Returns

\Orpheus\Core\srting

suggestResolver()

suggestResolver(string  $class)

Suggest resolve $class

Parameters

string

$class

setResolver()

setResolver(string  $class)

Set the resolver class

Parameters

string

$class

getRoute()

getRoute(string  $route) : \Orpheus\InputController\CLIController\CLIRoute

Get the route object for the $route name

Parameters

string

$route

Returns

\Orpheus\InputController\CLIController\CLIRoute

prepare()

prepare(\Orpheus\InputController\CLIController\CLIRequest  $request)

Prepare environment for this route

Parameters

\Orpheus\InputController\CLIController\CLIRequest

$request

getRootCommand()

getRootCommand()

getUsageCommand()

getUsageCommand()

__toString()

__toString() : string

Get route as string

Returns

string

register()

register(string  $name, string  $path, string  $controller, array  $parameters, array  $options = array())

Register route by $name

Parameters

string	$name
string	$path
string	$controller
array	$parameters
array	$options

getParameters()

getParameters()

__construct()

__construct(string  $name, string  $path, string  $controller, array<mixed,string>  $parameters, array  $options)

Constructor

Parameters

string	$name
string	$path
string	$controller
array<mixed,string>	$parameters
array	$options