class Help extends CommandSet

Class Help

Properties

protected Console $console from  CommandSet
protected CommandDefinition[] $commandDefinitions from  CommandSet

Methods

__construct(Console $console)

CommandSet constructor.

getCommandDefinition(string $command)

No description

array
getCommandDefinitions()

No description

array
getGlobalOptions()

No description

getLogger()

No description

bool
hasCommandDefinition(string $name)

No description

registerCommandDefinition(string $name, string $definition)

Registers the command definition by creating a new instance, saves as internal property and return it for further definition.

XF
requireXF(array $skips = [], array $instantiationClosures = [])

No description

void
runCommand(Input $input, Output $output)

No description

void
runHelp(Input $input, Output $output)

Prints a list of arguments and options for given command.

void
setupCommandDefinitions()

No description

Details

in CommandSet at line 29
__construct(Console $console)

CommandSet constructor.

Parameters

Console $console

in CommandSet at line 67
CommandDefinition getCommandDefinition(string $command)

No description

Parameters

string $command

Return Value

CommandDefinition

in CommandSet at line 87
array getCommandDefinitions()

No description

Return Value

array

at line 127
protected array getGlobalOptions()

No description

Return Value

array

in CommandSet at line 119
protected ConsoleLogger getLogger()

No description

Return Value

ConsoleLogger

in CommandSet at line 80
bool hasCommandDefinition(string $name)

No description

Parameters

string $name

Return Value

bool

in CommandSet at line 100
protected CommandDefinition registerCommandDefinition(string $name, string $definition)

Registers the command definition by creating a new instance, saves as internal property and return it for further definition.

Parameters

string $name
string $definition

Return Value

CommandDefinition

in CommandSet at line 130
protected XF requireXF(array $skips = [], array $instantiationClosures = [])

No description

Parameters

array $skips
array $instantiationClosures

Return Value

XF

in CommandSet at line 44
void runCommand(Input $input, Output $output)

No description

Parameters

Input $input
Output $output

Return Value

void

at line 35
void runHelp(Input $input, Output $output)

Prints a list of arguments and options for given command.

Instantiates the current command to retrieve its command definition which is used for printing the help.

Parameters

Input $input
Output $output

Return Value

void

at line 19
void setupCommandDefinitions()

No description

Return Value

void