HelpCommand
extends AbstractCommand
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- execute() : void
- Execute the command
- getDescription() : string
- Get the command description
- getDetailedHelp() : string
- Get detailed help text for this command
- getName() : string
- Get the command name
- error() : never
- Output an error and exit
- out() : void
- Output a message
- showAllHelp() : void
- Show comprehensive help for all commands
- showBasicHelp() : void
- Show basic command list
- showCommandHelp() : void
- Show detailed help for a specific command
Properties
$registry
private
CommandRegistry
$registry
Methods
__construct()
public
__construct(CommandRegistry $registry) : mixed
Parameters
- $registry : CommandRegistry
execute()
Execute the command
public
execute(array<string|int, mixed> $args) : void
Parameters
- $args : array<string|int, mixed>
-
Command line arguments
Tags
getDescription()
Get the command description
public
getDescription() : string
Tags
Return values
string —A brief description of what this command does
getDetailedHelp()
Get detailed help text for this command
public
getDetailedHelp() : string
Tags
Return values
stringgetName()
Get the command name
public
getName() : string
Tags
Return values
string —The unique name identifier for this command
error()
Output an error and exit
protected
error(string $message) : never
Parameters
- $message : string
Return values
neverout()
Output a message
protected
out(string $message) : void
Parameters
- $message : string
showAllHelp()
Show comprehensive help for all commands
private
showAllHelp() : void
showBasicHelp()
Show basic command list
private
showBasicHelp() : void
showCommandHelp()
Show detailed help for a specific command
private
showCommandHelp(string $commandName) : void
Parameters
- $commandName : string