class RoutingCommandController extends CommandController (View source)

Command controller for tasks related to routing

Properties

protected Request $request from  CommandController
protected Response $response from  CommandController
protected Arguments $arguments from  CommandController
protected string $commandMethodName

Name of the command method

from  CommandController
protected ObjectManagerInterface $objectManager
protected CommandManager $commandManager from  CommandController
protected ConsoleOutput $output from  CommandController
protected ConfigurationManager $configurationManager
protected Router $router
protected ServerRequestFactory $serverRequestFactory

Methods

__construct()

Constructs the command controller

void
injectCommandManager(CommandManager $commandManager)

No description

void
injectObjectManager(ObjectManagerInterface $objectManager)

Injects the reflection service

void
processRequest(Request $request, Response $response)

Processes a command line request.

string
resolveCommandMethodName()

Resolves and checks the current command method name

void
initializeCommandMethodArguments()

Initializes the arguments array of this controller by creating an empty argument object for each of the method arguments found in the designated command method.

void
mapRequestArgumentsToControllerArguments()

Maps arguments delivered by the request object to the local controller arguments.

void
forward(string $commandName, string $controllerObjectName = null, array $arguments = [])

Forwards the request to another command and / or CommandController.

void
callCommandMethod()

Calls the specified command method and passes the arguments.

string
getFlowInvocationString()

Returns the CLI Flow command depending on the environment

void
output(string $text, array $arguments = [])

Outputs specified text to the console window You can specify arguments that will be passed to the text via sprintf

void
outputLine(string $text = '', array $arguments = [])

Outputs specified text to the console window and appends a line break

void
outputFormatted(string $text = '', array $arguments = [], int $leftPadding = 0)

Formats the given text to fit into MAXIMUM_LINE_LENGTH and outputs it to the console window

void
quit(int $exitCode = 0)

Exits the CLI through the dispatcher and makes sure that Flow is properly shut down.

void
sendAndExit(int $exitCode = 0)

Sends the response and exits the CLI without any further code execution Should be used for commands that flush code caches.

void
listCommand()

List the known routes

void
showCommand(int $index)

Show information for a route

void
getPathCommand(string $package, string $controller = 'Standard', string $action = 'index', string $format = 'html')

Generate a route path

void
routePathCommand(string $path, string $method = 'GET')

Route the given route path

string|null
getControllerObjectName(string $packageKey, string|null $subPackageKey, string $controllerName)

Returns the object name of the controller defined by the package, subpackage key and controller name or NULL if the controller does not exist

Details

__construct()

Constructs the command controller

void injectCommandManager(CommandManager $commandManager)

No description

Parameters

CommandManager $commandManager

Return Value

void

void injectObjectManager(ObjectManagerInterface $objectManager)

Injects the reflection service

Parameters

ObjectManagerInterface $objectManager

Return Value

void

void processRequest(Request $request, Response $response)

Processes a command line request.

Parameters

Request $request

The request object

Response $response

The response, modified by the controller

Return Value

void

Exceptions

InvalidArgumentTypeException
NoSuchCommandException

protected string resolveCommandMethodName()

Resolves and checks the current command method name

Note: The resulting command method name might not have the correct case, which isn't a problem because PHP is case insensitive regarding method names.

Return Value

string

Method name of the current command

Exceptions

NoSuchCommandException

protected void initializeCommandMethodArguments()

Initializes the arguments array of this controller by creating an empty argument object for each of the method arguments found in the designated command method.

Return Value

void

Exceptions

InvalidArgumentTypeException

protected void mapRequestArgumentsToControllerArguments()

Maps arguments delivered by the request object to the local controller arguments.

Return Value

void

protected void forward(string $commandName, string $controllerObjectName = null, array $arguments = [])

Forwards the request to another command and / or CommandController.

Request is directly transferred to the other command / controller without the need for a new request.

Parameters

string $commandName
string $controllerObjectName
array $arguments

Return Value

void

Exceptions

StopCommandException

protected void callCommandMethod()

Calls the specified command method and passes the arguments.

If the command returns a string, it is appended to the content in the response object. If the command doesn't return anything and a valid view exists, the view is rendered automatically.

Return Value

void

string getFlowInvocationString()

Returns the CLI Flow command depending on the environment

Return Value

string

protected void output(string $text, array $arguments = [])

Outputs specified text to the console window You can specify arguments that will be passed to the text via sprintf

Parameters

string $text

Text to output

array $arguments

Optional arguments to use for sprintf

Return Value

void

See also

http://www.php.net/sprintf

protected void outputLine(string $text = '', array $arguments = [])

Outputs specified text to the console window and appends a line break

Parameters

string $text

Text to output

array $arguments

Optional arguments to use for sprintf

Return Value

void

See also

output()
outputLines()

protected void outputFormatted(string $text = '', array $arguments = [], int $leftPadding = 0)

Formats the given text to fit into MAXIMUM_LINE_LENGTH and outputs it to the console window

Parameters

string $text

Text to output

array $arguments

Optional arguments to use for sprintf

int $leftPadding

The number of spaces to use for indentation

Return Value

void

See also

outputLine()

protected void quit(int $exitCode = 0)

Exits the CLI through the dispatcher and makes sure that Flow is properly shut down.

If your command relies on functionality which is triggered through the Bootstrap shutdown (such as the persistence framework), you must use quit() instead of exit().

Parameters

int $exitCode

Exit code to return on exit (see http://www.php.net/exit)

Return Value

void

Exceptions

StopCommandException

protected void sendAndExit(int $exitCode = 0)

Sends the response and exits the CLI without any further code execution Should be used for commands that flush code caches.

Parameters

int $exitCode

Exit code to return on exit

Return Value

void

void listCommand()

List the known routes

This command displays a list of all currently registered routes.

Return Value

void

void showCommand(int $index)

Show information for a route

This command displays the configuration of a route specified by index number.

Parameters

int $index

The index of the route as given by routing:list

Return Value

void

void getPathCommand(string $package, string $controller = 'Standard', string $action = 'index', string $format = 'html')

Generate a route path

This command takes package, controller and action and displays the generated route path and the selected route:

./flow routing:getPath --format json Acme.Demo\Sub\Package

Parameters

string $package

Package key and subpackage, subpackage parts are separated with backslashes

string $controller

Controller name, default is 'Standard'

string $action

Action name, default is 'index'

string $format

Requested Format name default is 'html'

Return Value

void

void routePathCommand(string $path, string $method = 'GET')

Route the given route path

This command takes a given path and displays the detected route and the selected package, controller and action.

Parameters

string $path

The route path to resolve

string $method

The request method (GET, POST, PUT, DELETE, ...) to simulate

Return Value

void

Exceptions

InvalidRoutePartValueException
StopCommandException

protected string|null getControllerObjectName(string $packageKey, string|null $subPackageKey, string $controllerName)

Returns the object name of the controller defined by the package, subpackage key and controller name or NULL if the controller does not exist

Parameters

string $packageKey

the package key of the controller

string|null $subPackageKey

the subpackage key of the controller

string $controllerName

the controller name excluding the "Controller" suffix

Return Value

string|null

The controller's Object Name or NULL if the controller does not exist