RoutingCommandController
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
Resolves and checks the current command method name
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.
Maps arguments delivered by the request object to the local controller arguments.
Forwards the request to another command and / or CommandController.
Calls the specified command method and passes the arguments.
Returns the CLI Flow command depending on the environment
Outputs specified text to the console window You can specify arguments that will be passed to the text via sprintf
Outputs specified text to the console window and appends a line break
Formats the given text to fit into MAXIMUM_LINE_LENGTH and outputs it to the console window
Exits the CLI through the dispatcher and makes sure that Flow is properly shut down.
Sends the response and exits the CLI without any further code execution Should be used for commands that flush code caches.
List the known routes
Show information for a route
Generate a route path
Route the given route path
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
void
injectObjectManager(ObjectManagerInterface $objectManager)
Injects the reflection service
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.
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.
protected void
mapRequestArgumentsToControllerArguments()
Maps arguments delivered by the request object to the local controller arguments.
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.
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.
string
getFlowInvocationString()
Returns the CLI Flow command depending on the environment
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
protected void
outputLine(string $text = '', array $arguments = [])
Outputs specified text to the console window and appends a line break
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
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().
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.
void
listCommand()
List the known routes
This command displays a list of all currently registered routes.
void
showCommand(int $index)
Show information for a route
This command displays the configuration of a route specified by index number.
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
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.
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