-
Notifications
You must be signed in to change notification settings - Fork 51
Help Output
Bertie2011 edited this page Aug 29, 2021
·
1 revision
The help output is influenced by overriding methods on subclasses from both CLIFramework\Application
and CLIFramework\Command
.
Method to override | Description |
---|---|
public function brief(): string |
A short piece of text (one line) that appears in the help output of the parent command, under the NAME header if defined in a command and at the very top if defined in the application. |
public function usage(): string |
Appears under the USAGE header. |
public function help(): string |
Appears at the bottom of the help output and can contain a long description. |
Additionally, $this->setProgramName($name)
can be called in the public init(): void
method to influence the output of generated suggested commands. By default the program name is the first argument in $argv
.