HelpSmartLineCommand
extends SmartLineCommand
in package
The standard command "help"
This command prints command help.
Help could be defined in the command classes, as a return value from the help method ; in the $lang['Help'] array, at the command key (e.g. $lang['Help']['quux'] for the quux command).
Table of Contents
Properties
- $SmartLine : SmartLine
- The SmartLine where this instance of the command is registered
Methods
- __construct() : mixed
- Initializes a new instance of the SmartLine Command
- help() : string|bool
- Gets the command help text or indicates help should be fetched from $lang array
- run() : mixed
- Runs the command
- parseBoolean() : bool
Properties
$SmartLine
The SmartLine where this instance of the command is registered
public
SmartLine
$SmartLine
Methods
__construct()
Initializes a new instance of the SmartLine Command
public
__construct(SmartLine $SmartLine) : mixed
Parameters
- $SmartLine : SmartLine
-
the SmartLine the command belongs
help()
Gets the command help text or indicates help should be fetched from $lang array
public
help() : string|bool
Return values
string|bool —a string containing the command help or the bool value false, to enable the default behavior (ie prints $lang['help']['nameOfTheCommand'])
run()
Runs the command
public
run(array<string|int, mixed> $argv, int $argc) : mixed
Parameters
- $argv : array<string|int, mixed>
-
an array of string, each item a command argument
- $argc : int
-
the number of arguments
parseBoolean()
protected
static parseBoolean(string $arg) : bool
Parameters
- $arg : string