PHP Class Neos\Flow\Command\HelpCommandController

Inheritance: extends Neos\Flow\Cli\CommandController
Datei anzeigen Open project: neos/flow-development-collection

Protected Properties

Property Type Description
$applicationName string
$applicationPackageKey string
$bootstrap Neos\Flow\Core\Bootstrap
$packageManager Neos\Flow\Package\PackageManagerInterface

Public Methods

Method Description
errorCommand ( Neos\Flow\Mvc\Exception\CommandException $exception ) : void Displays an error message
helpCommand ( string $commandIdentifier = null ) : void Display help for a command
helpStubCommand ( ) : void Displays a short, general help message

Protected Methods

Method Description
buildCommandsIndex ( array $commands ) : array Builds an index of available commands. For each of them a Command object is added to the commands array of this class.
displayHelpForCommand ( Command $command ) : void Render help text for a single command
displayHelpIndex ( ) : void
displayShortHelpForCommands ( array $commands ) : void

Method Details

buildCommandsIndex() protected method

Builds an index of available commands. For each of them a Command object is added to the commands array of this class.
protected buildCommandsIndex ( array $commands ) : array
$commands array
return array in the format array('' => array('', array('' => $command1, '' => $command2)))

displayHelpForCommand() protected method

Render help text for a single command
protected displayHelpForCommand ( Command $command ) : void
$command Neos\Flow\Cli\Command
return void

displayHelpIndex() protected method

protected displayHelpIndex ( ) : void
return void

displayShortHelpForCommands() protected method

protected displayShortHelpForCommands ( array $commands ) : void
$commands array
return void

errorCommand() public method

Displays an error message
public errorCommand ( Neos\Flow\Mvc\Exception\CommandException $exception ) : void
$exception Neos\Flow\Mvc\Exception\CommandException
return void

helpCommand() public method

The help command displays help for a given command: ./flow help
public helpCommand ( string $commandIdentifier = null ) : void
$commandIdentifier string Identifier of a command for more details
return void

helpStubCommand() public method

This only outputs the Flow version number, context and some hint about how to get more help about commands.
public helpStubCommand ( ) : void
return void

Property Details

$applicationName protected_oe property

protected string $applicationName
return string

$applicationPackageKey protected_oe property

protected string $applicationPackageKey
return string

$bootstrap protected_oe property

protected Bootstrap,Neos\Flow\Core $bootstrap
return Neos\Flow\Core\Bootstrap

$packageManager protected_oe property

protected PackageManagerInterface,Neos\Flow\Package $packageManager
return Neos\Flow\Package\PackageManagerInterface